codebase-documenter

To generate documentation for an unfamiliar codebase, this Skill analyzes repository structure, source files, and existing notes to produce clear developer-facing guides like READMEs and architecture overviews. It applies template-driven writing for beginner-friendly technical docs.

The best way to create a README for a legacy project is to use template-driven writing that converts existing repository structures and source files into clear project overviews, setup steps, and common task guides without rewriting the codebase.

Yes, you can document system architecture and data flow for complex repositories. This Skill maps multi-module system structures, dependencies, and design decisions into clear architecture documentation for new contributors.

To write API documentation and inline code comments, this Skill requires accurate file analysis to produce endpoint references and explanatory code comments that make existing logic easier to maintain and extend.

No, generating onboarding materials for developers does not require rewriting source code. The Skill transforms existing repository files and notes into clear technical documentation, allowing teams to inherit legacy apps without modifying the underlying codebase.

You should not use automated codebase documentation tools when a project lacks accurate source files or existing notes for analysis, as template-driven writing requires concrete repository structures to produce clear developer-facing guides.