← Back to Factory Recipes
๐Ÿ“

Documentation Factory

Automated documentation generation with source analysis, drafting, and review

Developer 5 stages 2 specialists v1.0.0

About

Generates comprehensive documentation from source code through a five-stage pipeline. An analyst scans the codebase for API surfaces and documentation gaps, a writer drafts structured docs with examples, and a reflection gate verifies technical accuracy before final polish.

Input / Output

Input

Codebase or module to document

codebase

Output

Comprehensive documentation with API references and usage examples

min quality: 0.75

Pipeline Stages

โšก

source analysis

Execute

Analyze source code structure, public APIs, and existing documentation gaps

๐Ÿ‘ค analyst ๐Ÿ”ง file_read, grep, glob
โšก

outline

Execute

Create documentation outline based on analysis findings

๐Ÿ‘ค writer ๐Ÿ”ง file_write โ† source analysis
โšก

draft

Execute

Write full documentation with API references, examples, and guides

๐Ÿ‘ค writer ๐Ÿ”ง file_read, file_write โ† outline
๐Ÿ”

technical review

Reflect

Verify technical accuracy of documentation against source code

โ† draft quality โ‰ฅ 0.8 max depth: 2
โšก

polish

Execute

Final editing pass for clarity, consistency, and completeness

๐Ÿ‘ค writer ๐Ÿ”ง file_read, file_write โ† technical review

Tags

docswritingautomation