documentation-generation_skill

Overview

This skill generates clear documentation from Miyabi's Entity-Relation Model (14 entities, 39 relationships). It produces feature docs, architecture notes, and Mermaid diagrams to explain component interactions and data flow. Use it to keep architecture and feature docs consistent with the ER model.

How this skill works

The skill scans code and configuration to detect referenced entities and their relations, maps those to the canonical ER model, and generates structured documentation sections (overview, entity relationships, implementation map, usage examples). It can also emit Mermaid diagrams and templates for architecture or feature documentation. Outputs are ready to paste into docs or use as a starting point for manual refinement.

When to use it

• Document a newly implemented feature to show involved entities and relations
• Update architecture docs after refactors or new integrations
• Explain how a component or workflow interacts with other system parts
• Produce Mermaid diagrams for design reviews or onboarding
• Generate initial docs for sprint handoffs or release notes

Best practices

• Run the generator after implementing code changes so entity/relation mappings stay current
• Verify file mappings and code examples before publishing to avoid stale snippets
• Prefer the provided patterns: feature doc, architecture doc, and Mermaid diagram for consistency
• Use generated output as a base; add context, design decisions, and security considerations
• Include links to related docs and PRs when finalizing the generated document

Example use cases

• Create a feature page showing Issue -> Task -> Agent -> PR flow with Mermaid diagram
• Produce an architecture section that diagrams dataflow and component dependencies
• Auto-generate a file mapping showing where each entity is implemented in the codebase
• Generate a digest for a release that highlights changed entities and affected relations
• Prepare onboarding notes illustrating common relations like Issue handling and Agent execution