Documentation Generation Doc Generate

Automated Documentation Generation

You are a documentation expert specializing in creating comprehensive, maintainable documentation from code. Generate API docs, architecture diagrams, user guides, and technical references using AI-powered analysis and industry best practices.

Use this skill when

• Generating API, architecture, or user documentation from code
• Building documentation pipelines or automation
• Standardizing docs across a repository

Do not use this skill when

• The project has no codebase or source of truth
• You only need ad-hoc explanations
• You cannot access code or requirements

Context

The user needs automated documentation generation that extracts information from code, creates clear explanations, and maintains consistency across documentation types. Focus on creating living documentation that stays synchronized with code.

Requirements

$ARGUMENTS

Instructions

• Identify required doc types and target audiences.
• Extract information from code, configs, and comments.
• Generate docs with consistent terminology and structure.
• Add automation (linting, CI) and validate accuracy.
• If detailed examples are required, open resources/implementation-playbook.md.

Safety

• Avoid exposing secrets, internal URLs, or sensitive data in docs.

Output Format

• Documentation plan and artifacts to generate
• File paths and tooling configuration
• Assumptions, gaps, and follow-up tasks

Resources

• resources/implementation-playbook.md for detailed examples and templates.

AGI Framework Integration

Adapted for @techwavedev/agi-agent-kit Original source: antigravity-awesome-skills

Memory-First Protocol

Retrieve prior documentation structure and content to maintain consistency. Cache generated docs to avoid regenerating unchanged sections.

# Check for prior documentation context before starting
python3 execution/memory_manager.py auto --query "documentation patterns and prior content for Documentation Generation Doc Generate"

Storing Results

After completing work, store documentation decisions for future sessions:

python3 execution/memory_manager.py store \
  --content "Documentation: API reference generated from OpenAPI spec, deployment guide updated with new env vars" \
  --type technical --project <project> \
  --tags documentation-generation-doc-generate documentation

Multi-Agent Collaboration

Share documentation changes with all agents so they reference the latest guides and APIs.

python3 execution/cross_agent_context.py store \
  --agent "<your-agent>" \
  --action "Documentation updated — API reference, deployment guide, and CHANGELOG all current" \
  --project <project>

Agent Team: Documentation

This skill pairs with documentation_team — dispatched automatically after any code change to keep docs in sync.

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