CtrlK
BlogDocsLog inGet started
Tessl Logo
SkillPublic

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

75%

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

56%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 body is well organized with exact commands and time-tiered sections, and it closes with validation and verification checklists. Its main weaknesses are prose-described configuration instead of copy-pasteable config files and a progressive-disclosure failure: both bundle reference files are duplicated inline and never referenced.

Suggestions

Add actual config file contents (a minimal mkdocs.yml, typedoc.json, and Sphinx conf.py snippet) instead of prose descriptions like 'Set extensions to include autodoc, napoleon, typehints, and myst_parser' — the exact configuration is the skill's core deliverable and is currently never shown.

Link the bundle files from the body (e.g., 'Full worked examples: see references/examples.md; tool and hosting details: see references/reference.md') and cut the duplicated Tool Reference section from SKILL.md so the reference file carries that content.

Remove the inline 'Version: 2.0.0 / Last Updated: 2025-12-30' footer (and reconcile it with the frontmatter's 2.1.0 / 2026-01-08), keeping date-sensitive details out of the always-loaded body.

DimensionReasoningScore

Conciseness

The prose is terse and command-oriented, but the inline 'Tool Reference' section (Sphinx/MkDocs/TypeDoc/OpenAPI/Nextra URLs) duplicates references/reference.md, the Implementation Guide overlaps references/examples.md, and 'Version: 2.0.0 / Last Updated: 2025-12-30' stamps add time-sensitive padding outside any deprecated section.

3 / 5

Actionability

Exact commands are present (pip/npm installs, 'sphinx-quickstart docs', 'mkdocs gh-deploy', 'sphinx-build -b html docs/source docs/build'), but every configuration is described in prose ('Set extensions to include autodoc, napoleon, typehints, and myst_parser') rather than shown — no actual conf.py, mkdocs.yml, or typedoc.json content appears, leaving the skill's main deliverable incomplete.

3 / 5

Workflow Clarity

Per-tool sequences (install → init → configure → generate → build/deploy) are clearly ordered, and a Documentation Validation section plus a final Verification checklist supply checkpoints; it falls short of 5 only because no explicit fix-and-retry feedback loop is embedded in the workflows.

4 / 5

Progressive Disclosure

The body is well sectioned with time-tiered headings (Quick Reference 30s / Implementation 5min / Advanced 10+), but it never links to its own bundle files — references/examples.md and references/reference.md are orphaned — and their content is largely re-inlined, matching 'content that should be separate is inline' with references not clearly signaled.

3 / 5

Total

13

/

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: third-person, concise, explicit 'Use when' triggers, and concrete tool names that carve out a distinct niche. Its only gaps are slightly generic capability verbs and a few missing natural trigger synonyms.

DimensionReasoningScore

Specificity

The description covers several specific capabilities ('technical specs, API docs, user guides, and knowledge bases') with named tools ('Sphinx, MkDocs, TypeDoc, and Nextra'), but its action verbs ('generate', 'create', 'build') stay generic rather than enumerating finer-grained operations, so it sits at 'several specific actions; minor gaps' rather than comprehensive.

4 / 5

Completeness

It explicitly answers both questions: a third-person 'what' ('Documentation generation patterns for technical specs, API docs, user guides, and knowledge bases using real tools like Sphinx, MkDocs, TypeDoc, and Nextra') followed by a concrete 'Use when' clause with three specific activity triggers ('creating docs from code, building doc sites, or automating documentation workflows'), matching the anchor for clearly and explicitly answering both.

5 / 5

Trigger Term Quality

Natural phrases a user would say are present ('creating docs from code', 'building doc sites', 'API docs', plus tool names like MkDocs and Sphinx), but common variations such as 'README', 'documentation site', or 'docstrings' are missing, matching 'good keyword coverage; a few natural terms missing'.

4 / 5

Distinctiveness Conflict Risk

The documentation-generation niche anchored by specific tools (Sphinx, MkDocs, TypeDoc, Nextra) is mostly distinct, with only minor overlap risk against closely related skills such as a dedicated Nextra or Python-docstring skill.

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.

Validation — 15 / 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

Path

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

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.