This skill should be used when writing documentation for codebases, including README files, architecture documentation, code comments, and API documentation. Use this skill when users request help documenting their code, creating getting-started guides, explaining project structure, or making codebases more accessible to new developers. The skill provides templates, best practices, and structured approaches for creating clear, beginner-friendly documentation.
Initial release of codebase-documenter: a skill for generating clear, structured documentation for codebases. - Provides templates and best practices for READMEs, architecture docs, code comments, and API documentation. - Emphasizes beginner-friendly documentation principles: clear "why" explanations, examples, context, and visual aids. - Outlines step-by-step workflow for analyzing codebases and choosing appropriate documentation types. - Includes detailed templates for README, architecture, and API docs in assets/templates/. - Covers inline code comment patterns for explaining complex or non-obvious code.