Autosnippet Devdocs

AutoSnippet — Wiki Documentation Generation

This skill guides the agent through generating structured Wiki documentation from the AutoSnippet knowledge base using the autosnippet_wiki MCP tool.

When to use this skill

• User asks to generate project documentation or wiki
• After a cold-start bootstrap completes — produce docs from newly captured knowledge
• When the user says "generate docs" / "write wiki" / "create documentation"
• After significant knowledge base changes — refresh documentation

MCP Tools

Workflow

Step 1: Plan topics

{
  "operation": "plan",
  "language": "en"
}

Returns:

• topics[] — Recommended documentation topics based on knowledge base content
• dataPackages — Per-topic data bundles (related Recipes, code patterns, architecture info)
• sessionId — Session identifier for the finalize step

Step 2: Write articles

For each topic in the plan:

1. Read the dataPackage for that topic
2. Write a well-structured Markdown article to the wiki directory (AutoSnippet/wiki/)
3. Use Recipe content as source of truth — cite Recipe titles
4. Follow the structure: Overview → Details → Code Examples → Related Topics

Step 3: Finalize

{
  "operation": "finalize",
  "sessionId": "<from plan>",
  "articlesWritten": ["AutoSnippet/wiki/topic-1.md", "AutoSnippet/wiki/topic-2.md"]
}

This triggers:

• meta.json generation — topic index with cross-references
• Dedup check — detect overlapping articles
• Completeness validation — ensure all planned topics are covered

Writing guidelines

• Use clear headings (##, ###) — helps search and scanning
• Include a summary section at the top of each article
• Reference file paths and class names concretely — improves search relevance
• Cite Recipe triggers (e.g., @bilidili-feature-url-routing) as knowledge sources
• For architecture docs: Context → Design → Implementation → Trade-offs
• For pattern docs: When to Use → How to Use → Code Example → Anti-patterns

Language parameter

Related Skills

Converted and distributed by TomeVault — claim your Tome and manage your conversions.