CtrlK
BlogDocsLog inGet started
Tessl Logo

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.

57

Quality

66%

Does it follow best practices?

Run evals on this skill

Adds up to 20 points to the overall score

View guide

SecuritybySnyk

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
SKILL.md
Quality
Evals
Security

Quality

Content

50%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.

The content is well-organized by time-to-invest tiers and covers many tools with real commands, but it relies on prose bullets instead of executable config/code blocks, buries validation outside the workflows, and never links to the existing reference bundle files despite inlining their content. Promoting config to code snippets and pointing to references/ would lift the weaker dimensions.

Suggestions

Replace the prose config bullet lists (conf.py, mkdocs.yml, typedoc.json, .github/workflows/docs.yml) with copy-paste-ready code blocks so the guidance is executable, not just descriptive.

Embed validation as explicit checkpoints inside the workflows (e.g. run linkchecker/markdown-link-check and fail the CI step before deploy) rather than listing validation as a separate, optional topic.

Move the inlined Tool Reference and worked examples into references/reference.md and references/examples.md and link to them from the body, so SKILL.md stays a lean overview and the bundle files earn their place.

DimensionReasoningScore

Conciseness

The body is mostly efficient and assumes Claude knows the tools, but it includes lightly padded sections (e.g. 'Key advantages: MDX support, file-system routing...' and explanatory bullet phrasing) that could be tightened, and there are no actual code blocks despite the topic inviting them; it sits at 'mostly efficient but some unnecessary explanation', so 3 rather than 4 (more padding than 'minor instances').

3 / 5

Actionability

It gives concrete commands (e.g. 'sphinx-apidoc ... then run make html', 'pip install ...', 'mkdocs serve') but presents config as prose bullet lists rather than executable conf.py / mkdocs.yml / typedoc.json snippets, so guidance is concrete but incomplete with key details in prose rather than copy-paste code; 3 rather than 4 (not 'mostly executable' code blocks).

3 / 5

Workflow Clarity

Sequences are present per tool (install -> configure -> generate), and a dedicated 'Documentation Validation' section exists, but the destructive/batch operations (CI/CD deploys, doc generation overwrites) lack explicit validate-then-proceed feedback loops; the validation is described as separate options rather than checkpoints embedded in the workflows, capping at 3 per the validation-cap guideline.

3 / 5

Progressive Disclosure

There is structure (Quick Reference / Implementation Guide / Advanced Patterns tiers) and bundle files exist in references/ (examples.md, reference.md), but the body never signals or links to those files, inlining ~300 lines of tool reference and examples that belong in the separate reference files; per the guideline to score against actual bundle structure, references present but not clearly signaled yields 3 rather than 4.

3 / 5

Total

12

/

20

Passed

Description

83%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 description that covers both what it does and when to use it with concrete trigger phrases and named tools. It could be tightened to fully comprehensive action coverage and add file-extension synonyms to reach the top of the scale.

DimensionReasoningScore

Specificity

The description names the domain and several concrete actions ('creating docs from code', 'building doc sites', 'automating documentation workflows') plus the specific tools (Sphinx, MkDocs, TypeDoc, Nextra), giving it specific actions with only minor coverage gaps, so 4 rather than 3 (more concrete actions than '1-2') and not 5 (the actions are fairly generic verbs rather than a comprehensive list of distinct operations).

4 / 5

Completeness

It explicitly answers both what ('Documentation generation patterns for technical specs, API docs, user guides, and knowledge bases using real tools...') and when ('Use when creating docs from code, building doc sites, or automating documentation workflows') with concrete trigger phrases, matching the score-5 anchor; it is not a 4 because both 'what' and 'when' are explicit and specific.

5 / 5

Trigger Term Quality

It includes natural terms users would say ('API docs', 'user guides', 'knowledge bases', 'building doc sites', 'documentation workflows') with good coverage, but lacks file extensions and common synonyms like '.md', 'README', 'developer docs', so 4 rather than 5.

4 / 5

Distinctiveness Conflict Risk

The niche is fairly clear (documentation generation via named static-site/API-doc tools) and unlikely to trigger for unrelated skills, but 'documentation workflows' is broad enough to risk minor overlap with related docs/ writing skills, so 4 rather than 5.

4 / 5

Total

17

/

20

Passed

Validation

93%

Checks the skill against the spec for correct structure and formatting. All validation checks must pass before discovery and implementation can be scored.

Validation15 / 16 Passed

Validation for skill structure

CriteriaDescriptionResult

allowed_tools_field

'allowed-tools' contains unusual tool name(s)

Warning

Total

15

/

16

Passed

Repository
modu-ai/moai-adk
Reviewed

Table of Contents

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.