moai-docs-generation

Documentation generation patterns for technical specs, API docs, user guides, and knowledge bases using real tools like Sphinx, MkDocs, TypeDoc, and Nextra. Use when creating docs from code, building doc sites, or automating documentation workflows.

Quality

71%

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

Fix and improve this skill with Tessl

tessl review fix ./.moai/archive/skills/v3.0/moai-docs-generation/SKILL.md

Quality

Content

50%

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

The content is a broad, monolithic guide covering many tools with real commands, but it leans on prose restatements of familiar tool docs rather than executable config examples, lacks inline validation checkpoints in its workflows, and fails to route detail into its own bundled reference files. It lands at the middle of the scale across all four dimensions.

Suggestions

Move the per-tool install/config detail and the Tool Reference link list into references/reference.md and examples.md, then link to them from a concise overview in SKILL.md so the references you already bundle are actually signaled and used.

Replace prose config descriptions ("Set extensions to include autodoc, napoleon, typehints, and myst_parser") with actual copy-paste conf.py / mkdocs.yml / typedoc.json snippets so guidance is executable rather than descriptive.

Add inline validation checkpoints to the build and CI/CD workflows (e.g., 'after sphinx-build, check for warnings; if present, fix and rebuild') and tie them into the existing Verification checklist as feedback loops.

Dimension	Reasoning	Score
Conciseness	The body is mostly efficient prose without conceptual padding, but at ~280 lines it rephrases public tool documentation Claude already knows (install commands, conf.py keys, FastAPI/Docusaurus config behavior) that could be tightened or delegated to the bundled reference files. It is not lean enough for a top score.	2 / 3
Actionability	It provides real commands ("pip install sphinx ...", "sphinx-build -b html docs/source docs/build", "mkdocs serve", "npm run docs:generate"), but most configuration is described in prose ("Set extensions to include autodoc, napoleon...", "Set site_name and site_url") rather than shown as copy-paste config snippets, leaving key details incomplete.	2 / 3
Workflow Clarity	Sequenced steps exist per tool and a Verification checklist is provided, but inline validation checkpoints and error-recovery feedback loops are missing in the build/CI workflows where they matter most; the validation guidance is decoupled into a later section rather than woven into the steps.	2 / 3
Progressive Disclosure	Two bundle references exist (references/examples.md, references/reference.md) but the body never signals or links to them, and the in-body 'Implementation Guide' and 'Tool Reference' duplicate material that belongs in those files. There is section structure, but content that should be separate is inline and references are not clearly signaled.	2 / 3
	Total	8 / 12 Passed

Description

92%

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 description that clearly states capabilities and provides an explicit 'Use when' trigger covering natural user phrases. The only weakness is moderate distinctiveness, since the broad 'creating docs' / 'building doc sites' triggers could plausibly overlap with other documentation-related skills.

Dimension	Reasoning	Score
Specificity	Names concrete documentation domains ("technical specs, API docs, user guides, and knowledge bases") alongside specific tools ("Sphinx, MkDocs, TypeDoc, and Nextra"), listing multiple specific capabilities rather than vague abstractions.	3 / 3
Completeness	Explicitly answers both what ("Documentation generation patterns for...") and when ("Use when creating docs from code, building doc sites, or automating documentation workflows"), satisfying the explicit trigger clause requirement.	3 / 3
Trigger Term Quality	Includes natural phrases users would say ("creating docs from code", "building doc sites", "automating documentation workflows") with good coverage of common variations rather than only technical jargon.	3 / 3
Distinctiveness Conflict Risk	The tool-focused niche (Sphinx/MkDocs/TypeDoc/Nextra) is fairly specific, but generic triggers like "creating docs" and "building doc sites" could still overlap with other writing or content skills. It is not clearly distinct enough to fully avoid conflict, yet the named tools keep it above the generic threshold.	2 / 3
	Total	11 / 12 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
allowed_tools_field	'allowed-tools' contains unusual tool name(s)	Warning

	Total	15 / 16 Passed

Repository: modu-ai/moai-adk
Path: .moai/archive/skills/v3.0/moai-docs-generation/SKILL.md
Commit: 05117b6

Reviewed: 1 day 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.