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.

Esta habilidad debe usarse al escribir documentación para bases de código, incluidos archivos README, documentación de arquitectura, comentarios de código y documentación de API. Utilice esta habilidad cuando los usuarios soliciten ayuda para documentar su código, crear guías de introducción, explicar la estructura del proyecto o hacer que las bases de código sean más accesibles para los nuevos desarrolladores. La habilidad proporciona plantillas, mejores prácticas y enfoques estructurados para crear documentación clara y fácil de usar para principiantes. Fuente: auldsyababua/instructor-workflow.