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.
Install with Tessl CLI
npx tessl i github:softaworks/agent-toolkit --skill crafting-effective-readmesOverall
score
87%
Does it follow best practices?
If you maintain this skill, you can automatically optimize it using the tessl CLI to improve its score:
npx tessl skill review --optimize ./path/to/skillValidation for skill structure
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.
The description has a clear 'Use when' clause which is a strength, and it identifies the specific file type (README). However, it lacks concrete action verbs describing what the skill actually does beyond vague 'templates and guidance', and could benefit from more trigger term variations to improve discoverability.
Suggestions
Add specific concrete actions like 'Generate project badges, create installation instructions, format API documentation sections, structure contribution guidelines'
Include more trigger term variations such as 'README.md', 'project documentation', 'repo description', 'markdown docs'
| 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 'format code examples'. | 2 / 3 |
Completeness | Clearly answers both what ('provides templates and guidance matched to your audience and project type') and when ('Use when writing or improving README files') with an explicit 'Use when' clause. | 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 specifically which helps distinguish it, but could potentially overlap with general documentation skills or markdown editing skills due to lack of more specific triggers. | 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 through a clear decision tree. It respects Claude's intelligence by providing structured guidance without over-explaining, uses tables effectively for quick reference, and appropriately delegates detailed content to referenced files. The process-oriented approach with explicit questions ensures consistent, audience-appropriate outputs.
| Dimension | Reasoning | Score |
|---|---|---|
Conciseness | Content is lean and efficient, using tables for quick scanning and avoiding unnecessary explanations. Every section serves a purpose without padding or explaining concepts Claude already knows. | 3 / 3 |
Actionability | Provides concrete, actionable guidance with specific questions to ask, clear task identification tables, and explicit process steps. The workflow is prescriptive rather than descriptive. | 3 / 3 |
Workflow Clarity | Clear 3-step process with explicit decision points (task identification → task-specific questions → final check). Each step has concrete actions and the workflow includes a validation checkpoint ('Anything else to highlight?'). | 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 (templates/, section-checklist.md, style-guide.md). | 3 / 3 |
Total | 12 / 12 Passed |
Validation
75%Checks the skill against the spec for correct structure and formatting. All validation checks must pass before discovery and implementation can be scored.
Validation — 12 / 16 Passed
Validation for skill structure
| Criteria | Description | Result |
|---|---|---|
description_voice | 'description' should use third person voice; found second person: 'your ' | Warning |
metadata_version | 'metadata' field is not a dictionary | Warning |
license_field | 'license' field is missing | Warning |
body_output_format | No obvious output/return/format terms detected; consider specifying expected outputs | Warning |
Total | 12 / 16 Passed | |
- 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.