CtrlK
BlogDocsLog inGet started
Tessl Logo

readme-generator

Use whenever the user wants to create, rewrite, or improve a README.md for a GitHub/GitLab repo, project, library, CLI tool, app, or package. Trigger on "write me a README", "make a README for this repo", "improve my project's README", "make my repo/GitHub page look professional", or requests for repo docs, project landing content, or quickstart docs. Also trigger when the user pastes project details, a package.json/pyproject.toml, or a repo link and asks for docs. Interviews the user with targeted questions, offers 4 distinct visual/structural README designs to pick from, researches any related or inspirational projects named, and produces a polished, SEO-optimized, beginner-friendly README.md with a full table of contents, working anchor links, badges, and a real quickstart. Not for generic blog posts or non-repo documentation.

69

Quality

85%

Does it follow best practices?

Run evals on this skill

Adds up to 20 points to the overall score

View guide

SecuritybySnyk

Low

Low-risk findings worth noting

SKILL.md
Quality
Evals
Security

Quality

Content

71%Weight 40%Scale 1-5

Reviews the quality of instructions and guidance provided to agents. Good implementation is clear, handles edge cases, and produces reliable results.

A well-structured, actionable interview-driven workflow with excellent progressive disclosure and a clear step sequence. Its main weakness is conciseness — motivational/justification prose inflates the body without adding actionable value — and the absence of an explicit validation feedback loop.

Suggestions

Cut the 'Why the interview matters' section and inline rationale (e.g. the '8 seconds / 2 minutes' paragraph) down to a single sentence or remove it; the workflow steps already justify the interview.

Add an explicit validation/review checkpoint between drafting and delivery (e.g. re-check that every badge, install command, and quickstart snippet corresponds to a real scanned value, and fix any fabrication before declaring done) to formalize the feedback loop.

Tighten the interview questions by removing restated justifications inside each bullet (e.g. 'This is the single highest-leverage section...') so the questions read as a direct checklist.

DimensionReasoningScore

Conciseness

Mostly efficient instruction prose, but includes unnecessary motivational justification (e.g. 'A README has about 8 seconds to convince a visitor to keep reading... Nearly every mediocre README fails because...') and parenthetical rationale that could be trimmed without losing actionability.

3 / 5

Actionability

Highly concrete guidance for an instruction-only skill: specific files to scan (package.json, pyproject.toml, Cargo.toml, go.mod, etc.), named tools (web_fetch, web_search, shields.io), explicit interview questions, and four described design options; minor gaps because the exact badge/anchor mechanics are deferred to reference files rather than shown inline.

4 / 5

Workflow Clarity

A clear five-step sequence (scan → interview → research → draft → deliver) with guards against fabrication and a deliver-time placeholder check, but it lacks an explicit validate→fix→retry feedback loop for error recovery.

4 / 5

Progressive Disclosure

The body is a concise overview pointing to two real, well-signaled one-level-deep reference files (references/design-styles.md and references/seo-and-structure.md) listed in a dedicated 'Reference files' section; heavy template/SEO mechanics are appropriately split out.

5 / 5

Total

16

/

20

Passed

Description

100%Weight 40%Scale 1-5

Based on the skill's description, can an agent find and select it at the right time? Clear, specific descriptions lead to better discovery.

The description is exemplary: third-person voice, comprehensive concrete actions, abundant natural trigger phrases, and an explicit 'when to use' clause plus a negative boundary. It cleanly hits the top anchor on every dimension.

DimensionReasoningScore

Specificity

Lists multiple concrete actions in third person ('Interviews the user with targeted questions, offers 4 distinct visual/structural README designs to pick from, researches any related or inspirational projects named, and produces a polished, SEO-optimized, beginner-friendly README.md with a full table of contents, working anchor links, badges, and a real quickstart'), giving comprehensive coverage of what the skill does.

5 / 5

Completeness

Explicitly answers both 'what' (interviews, offers designs, researches, produces README with TOC/anchors/badges/quickstart) and 'when' (explicit 'Use whenever...' and 'Trigger on...' clauses with concrete trigger phrases).

5 / 5

Trigger Term Quality

Comprehensive natural trigger phrases including quoted user utterances ('write me a README', 'make a README for this repo', 'improve my project's README', 'make my repo/GitHub page look professional') plus file signals (package.json/pyproject.toml, repo link) and synonym terms (repo docs, quickstart docs).

5 / 5

Distinctiveness Conflict Risk

Clear niche (README.md generation for repos/projects/packages) with an explicit negative boundary ('Not for generic blog posts or non-repo documentation'), minimizing conflict with other docs-oriented skills.

5 / 5

Total

20

/

20

Passed

Validation

93%

Checks the skill against the spec for correct structure and formatting. All validation checks must pass before discovery and implementation can be scored.

Validation — 15 / 16 Passed

Validation for skill structure

CriteriaDescriptionResult

relative_links

Relative link issues: 1 missing

Warning

Total

15

/

16

Passed

Repository
administrakt0r/pro-skills-repo-administraktor
Reviewed

Table of Contents

Is this your skill?

If you maintain this skill, you can claim it as your own. Once claimed, you can manage eval scenarios, bundle related skills, attach documentation or rules, and ensure cross-agent compatibility.