CtrlK
BlogDocsLog inGet started
Tessl Logo
SkillPublic

readme-generator

Generate comprehensive, user-friendly README.md files for code repositories. Use when creating documentation for new projects, updating existing READMEs, or improving project onboarding. Produces READMEs with project introduction, prerequisites, environment setup, executable usage instructions, and repository structure overview. Supports application projects, libraries, and research codebases.

Quality

80%

Does it follow best practices?

Run evals on this skill

Adds up to 20 points to the overall score

View guide
SecuritybySnyk

Passed

No findings from the security scan

Fix and improve this skill with Tessl

tessl review fix ./skills/readme-generator/SKILL.md
SKILL.md
Quality
Evals
Security

Quality

Content

63%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.

The content delivers a clear, actionable workflow with concrete templates that would reliably produce good READMEs, but it is monolithic and padded: no reference files offload the template bulk, and the Quality Guidelines/Tips sections duplicate knowledge Claude already has. Validation guidance exists but is implicit rather than an explicit workflow checkpoint.

Suggestions

Move the bulky README section templates (prerequisites, installation, usage, repository structure) into a references/templates.md file and keep SKILL.md as a lean workflow overview with clearly signaled one-level-deep links.

Make validation an explicit workflow step (e.g., step 8: verify every generated command runs in a fresh environment and the version badge matches the actual version) instead of a footnote in Tips.

Delete or drastically trim the 'README Quality Guidelines' and 'Tips' sections, which restate general knowledge Claude already has ('use simple direct language', 'use syntax-highlighted code blocks').

DimensionReasoningScore

Conciseness

The ~420-line body is mostly deliverable templates (appropriate artifacts for a generator skill), but the 'README Quality Guidelines' and 'Tips' sections restate knowledge Claude already has ('Use simple, direct language', 'Avoid jargon', 'Use code blocks with language syntax highlighting', 'Keep the README focused'), matching 'mostly efficient but includes some unnecessary explanation or could be tightened'. It is not level 4 because the removable padding is more than minor.

3 / 5

Actionability

Concrete guidance throughout: exact key files to examine (package.json, pyproject.toml, Cargo.toml, go.mod...), an explicit extraction checklist, and copy-paste-ready section templates with example commands. Placeholders like [Project Name] and [command] are acceptable for a generator, leaving only minor gaps versus the fully-executable level-5 anchor.

4 / 5

Workflow Clarity

A clear, well-sequenced 7-step workflow (analyze structure → introduction → prerequisites → installation → usage → repository structure → additional sections) with embedded verification guidance ('Verify installation' template step, 'Test all commands in a fresh environment before finalizing'). Validation checkpoints are present but loosely placed in Tips rather than as explicit workflow steps, so it sits below level 5 and above level 3's 'checkpoints missing or implicit'.

4 / 5

Progressive Disclosure

No bundle files exist; the entire ~420-line body is a single monolithic file where bulky section templates (prerequisites, installation, usage, structure formats) clearly belong in reference files, matching 'some structure but could be better organized; content that should be separate is inline'. The section headers keep it above level 2, but at this length the absence of any references/signaled split prevents level 4.

3 / 5

Total

14

/

20

Passed

Description

88%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.

A strong description: concrete, comprehensive capability list in third-person voice with an explicit 'Use when...' clause covering three trigger scenarios. The only gaps are a few missing natural trigger synonyms and slight overlap risk with general documentation tasks.

DimensionReasoningScore

Specificity

The description lists multiple specific concrete actions with comprehensive coverage: 'Generate comprehensive, user-friendly README.md files', 'Produces READMEs with project introduction, prerequisites, environment setup, executable usage instructions, and repository structure overview', plus supported project types (applications, libraries, research codebases). It matches the level-5 anchor of multiple specific actions comprehensively described, exceeding the 'several specific actions with minor gaps' of level 4.

5 / 5

Completeness

Both are explicitly answered: what ('Generate comprehensive, user-friendly README.md files... Produces READMEs with project introduction, prerequisites, environment setup, executable usage instructions, and repository structure overview') and when ('Use when creating documentation for new projects, updating existing READMEs, or improving project onboarding') with three concrete trigger scenarios — matching the level-5 anchor exactly.

5 / 5

Trigger Term Quality

Natural trigger phrases are present ('creating documentation for new projects', 'updating existing READMEs', 'improving project onboarding', 'README.md'), but common variations users would say — e.g. 'write a readme', 'docs', 'project setup docs' — are missing, matching 'good keyword coverage; a few natural terms missing' rather than the comprehensive-synonym coverage of level 5.

4 / 5

Distinctiveness Conflict Risk

The README-generation niche with README-specific triggers is mostly distinct, but 'creating documentation for new projects' is somewhat broad and could overlap with general documentation-writing or onboarding skills — 'minor overlap risk with closely related skills' (level 4) rather than the minimal-conflict level 5.

4 / 5

Total

18

/

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: 2 missing

Warning

Total

15

/

16

Passed

Repository

ArabelaTso/Skills-4-SE

Path

skills/readme-generator/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.