codebase-documenter

To generate architecture documentation for an unfamiliar codebase, this skill explores and maps the project structure, identifies design patterns, and traces data flow to synthesize a comprehensive markdown guide.

The best way to create developer onboarding materials is to extract knowledge from critical files, detailing project components, setup instructions, and deployment guidelines into an easy-to-understand markdown document.

You can document system architecture and component breakdowns without manually reading every file by executing an automated exploration process that reads critical files and identifies key modules to extract structural knowledge.

Codebase documentation generation works for understanding complex data flow and design patterns by mapping the execution paths and identifying architectural patterns embedded within the source code.

A limitation of automated codebase documentation is that it relies on reading critical files and pattern identification, meaning it may not capture undocumented business logic or highly nuanced architectural decisions without explicit code comments.