codebase-documenter

This skill enables creating comprehensive, beginner-friendly documentation for codebases. It provides structured templates and best practices for writing READMEs, architecture guides, code comments, and API documentation that help new users quickly understand and contribute to projects.

When documenting code for new users, follow these fundamental principles:

When to create: For project root directories, major feature modules, or standalone components.

在编写代码库文档时应该使用此技能，包括 README 文件、架构文档、代码注释和 API 文档。当用户请求帮助记录其代码、创建入门指南、解释项目结构或使新开发人员更容易访问代码库时，请使用此技能。该技能提供了模板、最佳实践和结构化方法，用于创建清晰、适合初学者的文档。 来源：auldsyababua/instructor-workflow。