Write clear, comprehensive technical documentation. Use when creating specs, architecture docs, runbooks, or API documentation. Handles technical specifications, system design docs, operational guides, and developer documentation with industry best practices.
68
54%
Does it follow best practices?
Impact
93%
1.22xAverage score across 3 eval scenarios
Passed
No known issues
Optimize this skill with Tessl
npx tessl skill review --optimize ./.agent-skills/technical-writing/SKILL.mdQuality
Discovery
82%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 is a solid description with good completeness and trigger term coverage. It clearly states when to use the skill and includes relevant keywords users would naturally mention. The main weakness is the lack of specific concrete actions beyond 'write' and 'handles', and some potential overlap risk with other documentation-related skills.
Suggestions
Add more specific actions like 'structure sections, create diagrams, define API endpoints, write code examples' to improve specificity
Include distinguishing details like supported formats or unique capabilities to reduce conflict risk with other documentation skills
| Dimension | Reasoning | Score |
|---|---|---|
Specificity | Names the domain (technical documentation) and lists document types (specs, architecture docs, runbooks, API documentation), but lacks specific concrete actions beyond 'write' and 'handles'. Doesn't specify what actions are performed on these documents. | 2 / 3 |
Completeness | Clearly answers both what ('Write clear, comprehensive technical documentation') and when ('Use when creating specs, architecture docs, runbooks, or API documentation'). Has explicit 'Use when...' clause with specific trigger scenarios. | 3 / 3 |
Trigger Term Quality | Good coverage of natural terms users would say: 'specs', 'architecture docs', 'runbooks', 'API documentation', 'technical specifications', 'system design docs', 'operational guides', 'developer documentation'. These are terms users naturally use when requesting documentation help. | 3 / 3 |
Distinctiveness Conflict Risk | Somewhat specific to technical documentation but could overlap with general writing skills or code documentation skills. The focus on 'technical' and specific doc types helps, but 'documentation' is broad enough to potentially conflict with other documentation-related skills. | 2 / 3 |
Total | 10 / 12 Passed |
Implementation
27%Reviews the quality of instructions and guidance provided to agents. Good implementation is clear, handles edge cases, and produces reliable results.
This skill is excessively verbose, treating Claude like a novice writer rather than an intelligent assistant. While it contains useful templates and concrete examples, the content is buried in generic writing advice and explanations of concepts Claude already understands. The document would benefit significantly from being split into a concise overview with references to separate template and example files.
Suggestions
Reduce content by 70%+ by removing explanations of basic concepts (active voice, conciseness, what changelogs are) and trusting Claude's existing knowledge
Split templates into a separate TEMPLATES.md file and reference it from the main skill
Remove the empty 'Examples' section or populate it with actual before/after documentation examples
Add a validation step in the workflow for verifying documentation accuracy against the actual system/code being documented
| Dimension | Reasoning | Score |
|---|---|---|
Conciseness | Extremely verbose at 400+ lines, explaining basic concepts Claude already knows (what active voice is, what a changelog is, basic markdown formatting). Includes extensive template boilerplate and generic writing advice that doesn't add value for an AI assistant. | 1 / 3 |
Actionability | Provides concrete templates and code examples which are useful, but much of the content is generic writing advice rather than executable guidance. The templates are copy-paste ready, but the 'Examples' section at the end is empty placeholder content. | 2 / 3 |
Workflow Clarity | Has a 5-step process (understand audience, choose type, write, add visuals, review) but lacks validation checkpoints. The self-review checklist is helpful but there's no feedback loop for iterating on documentation quality or verifying accuracy. | 2 / 3 |
Progressive Disclosure | Monolithic wall of text with no references to external files. All templates, examples, and tool lists are inline when they could be split into separate reference files. No navigation aids for the 400+ line document. | 1 / 3 |
Total | 6 / 12 Passed |
Validation
81%Checks the skill against the spec for correct structure and formatting. All validation checks must pass before discovery and implementation can be scored.
Validation — 9 / 11 Passed
Validation for skill structure
| Criteria | Description | Result |
|---|---|---|
skill_md_line_count | SKILL.md is long (582 lines); consider splitting into references/ and linking | Warning |
metadata_version | 'metadata.version' is missing | Warning |
Total | 9 / 11 Passed | |
c033769
Table of Contents
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.