documentation-writer

Create or revise software documentation using the Diátaxis distinction between tutorials, how-to guides, reference, and explanation. Use for README sections, product and API documentation, operational guides, onboarding material, or restructuring an existing documentation set.

Quality

84%

Does it follow best practices?

Run evals on this skill

Adds up to 20 points to the overall score

View guide

Securityby

Low

Low-risk findings worth noting

Quality

Content

75%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, instruction-only skill with clear sequencing, a verification checkpoint, and a final checklist. It could be strengthened with worked examples and an explicit error-recovery feedback loop.

Suggestions

Add one short worked example per Diátaxis type (e.g. a before/after README snippet) to lift actionability from guidance to copy-paste-ready reference.

Turn the workflow's verify step into an explicit feedback loop ('if verification fails, fix and re-verify before proceeding') to reach the score-5 workflow anchor.

Tighten the evidence/safety boundaries bullets by merging near-duplicate points to improve token efficiency.

Dimension	Reasoning	Score
Conciseness	Mostly lean, actionable guidance that assumes Claude's competence; a few passages (e.g. the evidence/safety bullets) could be tightened without losing meaning, sitting just below the every-token-earns-its-place level.	4 / 5
Actionability	Concrete, specific guidance per document type and a numbered workflow; as an instruction-only skill the absence of code is acceptable, but it lacks worked examples (e.g. a sample transformed doc fragment), leaving minor gaps versus fully copy-paste-ready guidance.	4 / 5
Workflow Clarity	A clear 6-step sequence with an explicit verification step (step 5) and a final checklist; it stops short of an explicit validate->fix->retry feedback loop, so it is not the score-5 anchor.	4 / 5
Progressive Disclosure	Well-organized into clearly headed sections with no unnecessary external references; at ~70 lines it exceeds the under-50-line simple-skill threshold, so it falls just short of the self-contained score-5 case.	4 / 5
	Total	16 / 20 Passed

Description

87%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, third-person description that clearly states what the skill does and when to use it with concrete trigger phrases. Minor room to add a few more natural synonyms/extensions for trigger terms.

Dimension	Reasoning	Score
Specificity	Names concrete actions ('Create or revise software documentation', 'restructuring an existing documentation set') plus the four Diátaxis types, giving several specific actions with only minor coverage gaps; not quite the comprehensive multi-action list of the score-5 anchor.	4 / 5
Completeness	Explicitly answers both 'what' (create/revise docs via Diátaxis) and 'when' via a concrete 'Use for ...' clause listing trigger scenarios, matching the score-5 anchor closely.	5 / 5
Trigger Term Quality	Strong natural terms users would say ('README sections', 'product and API documentation', 'operational guides', 'onboarding material'), with only a few synonyms/extensions missing, matching the good-coverage anchor short of comprehensive.	4 / 5
Distinctiveness Conflict Risk	A clear niche (Diátaxis-based documentation) with distinct triggers and minimal overlap with other skills, matching the minimal-conflict anchor.	5 / 5
	Total	18 / 20 Passed

Validation

93%

Warnings & errors only

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

Criteria	Description	Result
frontmatter_unknown_keys	Unknown frontmatter key(s) found; consider removing or moving to metadata	Warning

	Total	15 / 16 Passed

Repository: iflytek/skillhub
Path: builtin-skills/skills/documentation-writer/SKILL.md
Commit: 7352597

Reviewed: 4 days ago

Table of Contents

Discovery Implementation Validation

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.