Documentation Generator

Generate comprehensive documentation from source code.

Step 1: Analyze Codebase

1. Identify project type and language(s)
2. Find existing documentation (README, docs/, wiki)
3. Detect documentation style in use (JSDoc, docstrings, rustdoc, etc.)
4. Map public API surface

Step 2: Documentation Types

Select what to generate:

• README.md - Project overview, installation, usage
• API Reference - Functions, classes, methods with signatures
• Architecture Doc - System design, component relationships
• Contributing Guide - Setup, coding standards, PR process
• Changelog - Version history from git tags/commits
• Inline Docs - JSDoc/docstrings for undocumented code

Step 3: Generate by Type

README.md

# Project Name

Brief description from package.json/setup.py/Cargo.toml

## Installation
[Detect from package manager]

## Quick Start
[Example from tests or main entry point]

## Usage
[Key API examples]

## Configuration
[Environment variables, config files]

## License
[From LICENSE file]

API Reference

For each public export:

## `functionName(param1, param2)`

Description from existing docstring or inferred from code.

**Parameters:**
- `param1` (type) - Description
- `param2` (type, optional) - Description. Default: `value`

**Returns:** type - Description

**Throws:** ErrorType - When condition

**Example:**
\`\`\`javascript
const result = functionName('value', { option: true });
\`\`\`

Architecture Doc

# Architecture Overview

## System Components
[Diagram of major modules/services]

## Data Flow
[How data moves through the system]

## Key Decisions
[Why certain patterns were chosen]

## Dependencies
[External services, libraries]

Inline Documentation

Add JSDoc/docstrings to undocumented code:

// Before
function processOrder(order, options) {
  // implementation
}

// After
/**
 * Processes an order through the fulfillment pipeline.
 *
 * @param order - The order to process
 * @param options - Processing options
 * @param options.priority - Priority level (1-5)
 * @param options.notify - Whether to send notifications
 * @returns The processed order with tracking info
 * @throws {ValidationError} If order is invalid
 */
function processOrder(order: Order, options: ProcessOptions): ProcessedOrder {
  // implementation
}

Step 4: Style Matching

Match existing documentation style:

Language	Style
JavaScript/TypeScript	JSDoc with @param, @returns
Python	Google-style or NumPy-style docstrings
Rust	/// doc comments with markdown
Go	GoDoc format
Java	Javadoc

Step 5: Output Options

1. Write to files - Create/update documentation files
2. Print to console - Review before saving
3. Create PR - Documentation update in a branch

Quality Checklist

• All public APIs documented
• Examples are runnable
• Types are accurate
• No placeholder text ("TODO", "Description here")
• Links are valid
• Consistent formatting throughout