mcpField
C
code-documentation-doc-generate

code-documentation-doc-generate

github.com/rmyndharisDevelopment1.9k44 installsUpdated 2w ago
Repository

About code-documentation-doc-generate

A skill for generating and maintaining API, architecture, user, and technical documentation from code. It is intended for teams automating documentation pipelines or standardizing docs across a repository, with guidance on consistency, validation, and sensitive-data handling.

Key features

  1. 01Generate documentation from code
  2. 02Cover API, architecture, and user docs
  3. 03Extract details from configs and comments
  4. 04Standardize terminology and structure
  5. 05Add linting and CI validation
  6. 06Avoid exposing sensitive data

Use cases

  1. 01Create API and architecture documentation
  2. 02Build an automated documentation pipeline
  3. 03Align documentation across a repository

Install

Copy the command and run it in a terminal.

$npx skills add https://github.com/rmyndharis/antigravity-skills --skill code-documentation-doc-generate

After installing, type/code-documentation-doc-generatein Claude Code to confirm it loaded.

Bundled filesresources/implementation-playbook.md

Details

From the project README

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.

Comments

Markdown supported