documentation-criteria

Documentation creation criteria including PRD, ADR, Design Doc, and Work Plan requirements with templates. Use when creating or reviewing technical documents, or determining which documents are required.

Quality

81%

Does it follow best practices?

Run evals on this skill

Adds up to 20 points to the overall score

View guide

Securityby

Passed

No findings from the security scan

Quality

Content

72%

Reviews the quality of instructions and guidance provided to agents. Good implementation is clear, handles edge cases, and produces reliable results.

A well-structured, information-dense criteria skill with concrete formats and properly split, verified template references one level deep. Its main gaps are minor internal redundancy that could be tightened and implicit rather than explicit inter-stage validation checkpoints in the creation workflow.

Suggestions

Tighten conciseness by merging the 'AI Automation Rules' section into the Creation Decision Matrix it restates, and consolidate the repeated per-document scope-boundary phrasing into a single shared convention.

Strengthen workflow_clarity by adding explicit validation gates between creation stages (e.g., 'Verify all PRD Required Structural Elements are present before drafting the Design Doc') so checkpoints are stated, not implied.

Consider promoting the 'Three Elements of Task Completion Definition' and ADR status transitions into an explicit validate→fix→retry feedback loop to make error recovery during document creation concrete.

Dimension	Reasoning	Score
Conciseness	Largely free of concept-padding Claude already knows, but at ~230 lines it could be tightened — the 'AI Automation Rules' section restates the Creation Decision Matrix, and the per-document 'Scope' boundary phrasing repeats a similar pattern across sections.	2 / 3
Actionability	Highly actionable instruction-only guidance: exact storage paths (docs/prd/), concrete naming conventions (ADR-[4-digits]-[title].md), explicit required structural elements, and copy-ready yaml template blocks for the change impact and interface matrices.	3 / 3
Workflow Clarity	Sequencing is clear via the Creation Decision Matrix and the 4-step Creation Process with an approval gate, but explicit validate-then-proceed checkpoints between document stages are largely implicit rather than spelled out as feedback loops.	2 / 3
Progressive Disclosure	The body is an overview/criteria layer pointing to six well-signaled, one-level-deep template references (all verified present in references/) via both a Templates section and a Storage Locations table, giving easy navigation.	3 / 3
	Total	10 / 12 Passed

Description

90%

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 states a clear niche, names the concrete document types it governs, and provides an explicit 'Use when' trigger. The only weakness is that the action verbs (creating, reviewing, determining) are general rather than granular concrete operations.

Dimension	Reasoning	Score
Specificity	Names the documentation domain and concrete artifacts (PRD, ADR, Design Doc, Work Plan) plus actions (creating, reviewing, determining which documents are required), but the verbs are general categories rather than the multiple specific concrete actions of the anchor-3 example.	2 / 3
Completeness	Clearly answers both 'what' (documentation creation criteria with templates for named document types) and 'when' via the explicit 'Use when creating or reviewing technical documents, or determining which documents are required' trigger.	3 / 3
Trigger Term Quality	Natural terms a user would say are well covered — 'PRD', 'ADR', 'Design Doc', 'Work Plan', and 'technical documents' are exactly the vocabulary used when requesting documentation work.	3 / 3
Distinctiveness Conflict Risk	A clear niche — technical documentation creation tied to specific named artifacts (PRD/ADR/Design Doc/Work Plan) — with distinct triggers unlikely to fire for unrelated skills.	3 / 3
	Total	11 / 12 Passed

Validation

100%

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 — 16 / 16 Passed

Validation for skill structure

No warnings or errors.

Repository: shinpr/claude-code-workflows
Path: skills/documentation-criteria/SKILL.md
Commit: 56ab6c1

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.