crafting-effective-readmes
Use when writing or improving README files. Not all READMEs are the same — provides templates and guidance matched to your audience and project type.
87
83%
Does it follow best practices?
Impact
92%
1.12xAverage score across 3 eval scenarios
Passed
No known issues
Quality
Discovery
67%Based on the skill's description, can an agent find and select it at the right time? Clear, specific descriptions lead to better discovery.
This description has good structure with an explicit 'Use when' clause and addresses both what and when. However, it lacks specific concrete actions beyond 'templates and guidance' and could benefit from more trigger term variations. The description is functional but could be more distinctive and detailed.
Suggestions
Add specific concrete actions like 'generate installation instructions, create usage examples, add badges, structure sections for open-source or internal projects'
Include more trigger term variations such as 'README.md', 'project documentation', 'repo description', or 'getting started guide'
| Dimension | Reasoning | Score |
|---|---|---|
Specificity | Names the domain (README files) and mentions 'templates and guidance' as actions, but lacks concrete specific actions like 'generate badges', 'create installation sections', or 'add usage examples'. | 2 / 3 |
Completeness | Explicitly answers both what ('provides templates and guidance matched to your audience and project type') and when ('Use when writing or improving README files') with a clear trigger clause at the start. | 3 / 3 |
Trigger Term Quality | Includes 'README files' as a natural keyword users would say, but misses common variations like 'README.md', 'documentation', 'project description', or 'repo docs'. | 2 / 3 |
Distinctiveness Conflict Risk | Focuses on README files which is fairly specific, but could overlap with general documentation skills or project setup skills. The mention of 'audience and project type' adds some distinction but isn't strongly differentiated. | 2 / 3 |
Total | 9 / 12 Passed |
Implementation
100%Reviews the quality of instructions and guidance provided to agents. Good implementation is clear, handles edge cases, and produces reliable results.
This is an excellent skill that efficiently guides README creation across different project types. It uses tables effectively for quick reference, provides clear decision trees, and appropriately delegates detailed content to referenced templates and guides. The process-oriented structure with explicit questions ensures Claude gathers necessary context before drafting.
| Dimension | Reasoning | Score |
|---|---|---|
Conciseness | The content is lean and efficient, using tables for quick scanning and avoiding explanations of concepts Claude already knows. Every section serves a clear purpose without padding. | 3 / 3 |
Actionability | Provides concrete, actionable guidance with specific questions to ask, clear task identification tables, and direct references to templates. The step-by-step process is immediately usable. | 3 / 3 |
Workflow Clarity | Clear three-step process with explicit decision points. Each task type has specific sub-steps, and the 'Always Ask' step provides a validation checkpoint before completion. | 3 / 3 |
Progressive Disclosure | Well-structured overview with clear one-level-deep references to templates and supporting files. Content is appropriately split between the main skill and referenced materials. | 3 / 3 |
Total | 12 / 12 Passed |
Validation
100%Checks the skill against the spec for correct structure and formatting. All validation checks must pass before discovery and implementation can be scored.
Validation — 11 / 11 Passed
Validation for skill structure
No warnings or errors.
- Repository
- softaworks/agent-toolkit
- Commit
3027f20
- 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.