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.

Questa competenza dovrebbe essere utilizzata durante la scrittura della documentazione per le basi di codice, inclusi file README, documentazione dell'architettura, commenti sul codice e documentazione API. Utilizza questa competenza quando gli utenti richiedono aiuto per documentare il proprio codice, creare guide introduttive, spiegare la struttura del progetto o rendere le basi di codice più accessibili ai nuovi sviluppatori. La competenza fornisce modelli, best practice e approcci strutturati per creare documentazione chiara e adatta ai principianti. Fonte: auldsyababua/instructor-workflow.