CtrlK
BlogDocsLog inGet started
Tessl Logo
SkillPublic

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.

72

Quality

90%

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

78%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, interview-driven instruction skill: the five-step workflow is explicit and easy to follow, guidance is concrete (specific files to scan, exact questions to ask, named design options), and detail is appropriately pushed into two real, clearly-signaled reference files. Remaining gaps are minor — a small amount of motivational padding, a few mechanics fully deferred to references with no inline fallback, and no post-generation validation step for the README's links/badges.

Suggestions

Trim the 'Why the interview matters' section to one or two directive sentences (e.g., 'Never generate a README without the interview — it is what separates a tailored README from a template'), cutting the 8-seconds/2-minutes narrative Claude doesn't need.

Add a lightweight validation step after drafting: re-check that every TOC anchor link resolves under GitHub's slug rules (per references/seo-and-structure.md) and that no badge or star count was fabricated, before presenting the file.

Include one inline fallback example (e.g., a single shields.io badge URL pattern or one anchor-slug transformation) so the skill still yields correct mechanics if a reference file cannot be read.

DimensionReasoningScore

Conciseness

The body is largely tight, actionable instruction ('Before asking the user anything, check what's already available', 'Get the *exact* commands — never invent install commands'), with only minor over-explanation such as the 'A README has about 8 seconds to convince a visitor' rationale paragraph and a few padded asides ('the kind that make a project look alive, trustworthy, and easy to try in under 60 seconds'). It is more than anchor 3 because the padding is incidental rather than systematic explanation of things Claude already knows.

4 / 5

Actionability

Guidance is mostly executable: a concrete scan list ('package.json, pyproject.toml, Cargo.toml, go.mod, setup.py, composer.json'), numbered interview questions, four named design options, and per-step deliverable rules ('always create it, don't just paste it in chat'). It falls short of anchor 5 because a few directives remain high-level (e.g., badge syntax and anchor slug rules are deferred to references rather than given any inline example), leaving minor gaps if the reference files were unavailable.

4 / 5

Workflow Clarity

The five steps (silent scan → batched interview → research → draft → deliver) are clearly sequenced, with most checkpoints present: mandatory pre-write reading of both reference files, 'never fabricate' rules for badges/stars/install commands, a placeholder summary on delivery, and an iterate-directly loop. It is not anchor 5 because there is no explicit validation of the produced README (e.g., verifying generated anchor links resolve) — checks are preventive rather than a validate-fix-retry loop.

4 / 5

Progressive Disclosure

The SKILL.md is a clear overview with both detail files split out one level deep and well signaled: 'Read `references/design-styles.md` for the full template' and 'Read `references/seo-and-structure.md` … both are required reading before writing', plus a closing 'Reference files' section describing each file's purpose and when to read it. Both referenced files exist in the bundle, and no content that belongs in references is bulk-inlined.

5 / 5

Total

17

/

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 a model example: it explicitly states what the skill does and when to use it with quoted, natural trigger phrases, uses third person, stays concrete throughout, and ends with a clear exclusion boundary. Its only weakness is length — it is on the padded side for a description field, though every clause carries trigger or capability information rather than fluff.

DimensionReasoningScore

Specificity

The description lists multiple specific concrete actions with comprehensive coverage: 'create, rewrite, or improve a README.md', 'Interviews the user with targeted questions', 'offers 4 distinct visual/structural README designs', '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'. No capability is left vague, and the voice is third person.

5 / 5

Completeness

Both what and when are explicitly and concretely answered: 'Use whenever the user wants to create, rewrite, or improve a README.md for a GitHub/GitLab repo… Trigger on…' gives the when with quoted trigger phrases, and the interview/designs/research/produce enumeration gives the what.

5 / 5

Trigger Term Quality

Trigger coverage is comprehensive and natural, quoting phrases users would actually say: '"write me a README"', '"make a README for this repo"', '"improve my project's README"', '"make my repo/GitHub page look professional"', plus synonyms ('repo docs', 'project landing content', 'quickstart docs') and concrete artifacts users paste ('a package.json/pyproject.toml, or a repo link').

5 / 5

Distinctiveness Conflict Risk

The niche is unambiguous — README.md files for code repositories — and it both lists repo-specific triggers (GitHub/GitLab repo, package.json/pyproject.toml, repo link) and draws an explicit boundary: 'Not for generic blog posts or non-repo documentation.' Minimal conflict risk with general writing or documentation 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

Path

skills/writing-skills/readme-writing-skill/SKILL.md

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.