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。