mg-document

Generate and maintain project documentation from code and annotations.

1|1|Updated Feb 4, 2026
One-click install
npx skills add https://github.com/wonton-web-works/miniature-guacamole --skill mg-document
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: mg-document
Source: https://github.com/wonton-web-works/miniature-guacamole/tree/main/src/framework/skills/mg-document
Command: npx skills add https://github.com/wonton-web-works/miniature-guacamole --skill mg-document

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

Automates generation and maintenance of project documentation from code and annotations.

Core Features & Use Cases

  • Documentation generation: READMEs, API docs, user guides, and inline comments.
  • Documentation reviews: quality checks, versioning, and updates across modules.
  • Use Case: When onboarding a new developer, invoke mg-document to produce a complete README and API reference from existing codebase.

Quick Start

Instruct mg-document to generate a README for the current repository.

Frequently Asked Questions about mg-document

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I generate README documentation from existing code automatically?

You can generate README documentation by automating extraction from code and annotations. The workflow orchestrates writer components to produce complete READMEs and API references directly from your multi-module codebase.

What is the best way to maintain API docs across a multi-module codebase?

Maintaining API docs across modules is handled through automated documentation reviews and versioning workflows. The system coordinates updates by synchronizing code changes with existing API documentation to ensure consistency.

Can I create a complete API reference and user guide from code annotations?

Yes, creating an API reference and user guide from code annotations is the core documentation generation feature. The workflow reads structured annotations and orchestrates output to satisfy structured-output requirements.

Does automated documentation generation work for onboarding new developers?

Automated documentation generation works effectively for developer onboarding. You can instruct the workflow to produce a complete README and API reference from the current repository to accelerate the onboarding process.

How do documentation reviews handle versioning and quality checks?

Documentation reviews handle versioning and quality checks through defined workflows that coordinate memory and writer orchestration. The system applies automated quality checks across modules to maintain documentation standards.