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.

Cette compétence doit être utilisée lors de la rédaction de documentation pour les bases de code, y compris les fichiers README, la documentation sur l'architecture, les commentaires de code et la documentation sur l'API. Utilisez cette compétence lorsque les utilisateurs demandent de l'aide pour documenter leur code, créer des guides de démarrage, expliquer la structure du projet ou rendre les bases de code plus accessibles aux nouveaux développeurs. La compétence fournit des modèles, des bonnes pratiques et des approches structurées pour créer une documentation claire et conviviale pour les débutants. Source : auldsyababua/instructor-workflow.