code-generate-document

Generate inline docs, ADRs, or module documentation for codebases.

Updated Aug 23, 2026
One-click install
npx skills add https://github.com/sirn/dotfiles --skill code-generate-document
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: code-generate-document
Source: https://github.com/sirn/dotfiles/tree/main/var/agents/skills/code-generate-document
Command: npx skills add https://github.com/sirn/dotfiles --skill code-generate-document

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Generate missing documentation or architectural decision records (ADRs).

Core Features & Use Cases

  • Inline Docs: Docstrings, comments for functions/classes
  • File/Module Docs: Top-level explanations (README.md updates)
  • ADR: Architecture Decision Record for design choices

Quick Start

Request documentation for a codebase and I will generate inline docs, ADRs, or module-level explanations.

Frequently Asked Questions about code-generate-document

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

FAQPage Schema
How do I auto-generate inline docstrings for functions and classes in my codebase?

You can auto-generate inline docstrings for functions and classes by analyzing your codebase changes. The system adapts to specific file paths or code modifications to produce inline documentation directly within your source files.

What is the best way to generate an Architecture Decision Record for a design choice?

Generating an Architecture Decision Record (ADR) for design choices involves analyzing code changes and formatting the architectural context into a standardized document. The output is written to standard locations such as the doc/adr/ directory.

Can I generate module-level documentation and update my README based on code changes?

Yes, you can generate module-level documentation and update README files. By analyzing specified arguments or code modifications, the system produces top-level explanations for modules and writes the results to standard documentation locations.

How does generating documentation for a codebase handle specific files or paths?

Generating documentation for a codebase handles specific files or paths by adapting to provided arguments or detected code changes. It focuses the documentation generation process on the targeted locations rather than the entire project.

Do I need to integrate with code review tools to format generated ADRs?

You do not need external code review tools to format generated ADRs, as the system integrates with convention-reviewer and code-architect components. These integrations handle output formatting and ensure the results meet architectural standards.

When should I use ADRs instead of inline docstrings for codebase documentation?

You should use ADRs instead of inline docstrings when documenting high-level architectural design choices rather than individual function or class behaviors. ADRs capture the context and rationale behind structural decisions, while inline docs explain implementation details.