aif-docs

Generate and maintain project documentation. Creates a lean README as a landing page with detailed docs pages split by topic in the configured docs directory. Use when user says "create docs", "write documentation", "update docs", "generate readme", or "document project".

Quality

82%

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

73%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-sequenced, highly actionable documentation skill with strong validation checkpoints and proper progressive disclosure of its checklist. Weakened by verbosity/redundancy and a missing referenced template file.

Suggestions

Consolidate the prev/next navigation and 'See Also' rules into one canonical location; reference it from Core Principles and Step 2.3 instead of re-explaining each time.

Tighten or templatize the repeated AskUserQuestion dialog blocks into a single reusable pattern to reduce token overhead.

Add the missing templates/html-template.html referenced in Step 3.2, or remove the reference and inline a minimal HTML scaffold so the --web path is fully executable.

Dimension	Reasoning	Score
Conciseness	The ~544-line body is mostly actionable but carries notable redundancy — the prev/next navigation pattern and 'See Also' rule are re-explained in Core Principles, Step 2.3, and the checklist — and the verbose AskUserQuestion dialog templates could be tightened.	3 / 5
Actionability	Provides concrete, copy-paste-ready templates for README and doc files, a file-move table with real targets, and a real command ('mkdir -p docs-html'); the markdown→HTML conversion step ('parse markdown → convert to HTML elements') stays abstract, leaving a minor gap.	4 / 5
Workflow Clarity	A clearly numbered Step 0→5 flow with explicit State A/B/C branching, a mandatory Step 4 review against two checklists, feedback loops ('Fix any issues found before presenting'), and pre-delete verification in Step 4.1 — satisfying the validation requirement for this destructive/batch skill.	5 / 5
Progressive Disclosure	Good structure with a clearly signaled one-level reference to references/REVIEW-CHECKLISTS.md (verified to exist), but the body also references templates/html-template.html which is not present in the bundle, a broken reference that caps the score below 5.	4 / 5
	Total	16 / 20 Passed

Description

91%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 both capability and explicit natural-language triggers. Minor gains available from naming the HTML/audit/consolidation capabilities to lift specificity.

Dimension	Reasoning	Score
Specificity	Lists several concrete actions — 'Generate and maintain project documentation', 'Creates a lean README as a landing page', 'detailed docs pages split by topic' — but omits notable capabilities (HTML/--web generation, audit, file consolidation), so it stops short of comprehensive coverage.	4 / 5
Completeness	Explicitly answers both 'what' (generate/maintain docs, README landing page, topic-split docs pages) and 'when' (concrete 'Use when user says...' trigger phrases), matching the top anchor.	5 / 5
Trigger Term Quality	Provides natural phrases users actually say with synonyms — 'create docs', 'write documentation', 'update docs', 'generate readme', 'document project' — giving comprehensive coverage of natural trigger terms.	5 / 5
Distinctiveness Conflict Risk	The documentation-generation niche with README+docs-dir split and specific triggers is mostly distinct, though generic phrases like 'write documentation' carry minor overlap risk with adjacent writing/markdown skills.	4 / 5
	Total	18 / 20 Passed

Validation

75%

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

Validation for skill structure

Criteria	Description	Result
skill_md_line_count	SKILL.md is long (556 lines); consider splitting into references/ and linking	Warning
allowed_tools_field	'allowed-tools' contains unusual tool name(s)	Warning
frontmatter_unknown_keys	Unknown frontmatter key(s) found; consider removing or moving to metadata	Warning
relative_links	Relative link issues: 18 missing, 4 suspicious	Warning

	Total	12 / 16 Passed

Repository: lee-to/ai-factory
Path: skills/aif-docs/SKILL.md
Commit: e144f95

Reviewed: 5 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.