docgen

To generate documentation from a codebase, this skill parses file structures and git history to produce READMEs, API references, architecture overviews, and changelogs. It outputs the proposed content in the conversation first for your review before writing anything to disk.

Yes, you can generate a readable changelog from git history. This skill analyzes version-range commit history, groups commits logically by type, and avoids dumping raw git logs into the final documentation output.

To update READMEs while preserving manual content, this skill scans existing file structures and retains manually written sections that already exist. It generates new documentation sections and integrates them without overwriting your custom additions.

Yes, generating API references requires confirmation before writing to disk. This skill enforces a mandatory review-first behavior by outputting the parsed API surface documentation to the conversation, ensuring you approve all file modifications before they occur.

The best way to create architecture overviews for specific directories is using doc-type-specific parsing. This skill analyzes targeted directory structures and codebase relationships to produce accurate architectural summaries without scanning unrelated project areas.

A key limitation when maintaining documentation for rapidly changing API surface areas is the required confirmation step before writing to disk. While this preserves manual content and ensures accuracy, it requires manual approval for every documentation update generated from the codebase.