codebase-documenter

SKILL.md

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 文檔。當用戶請求幫助記錄其代碼、創建入門指南、解釋項目結構或使新開發人員更容易訪問代碼庫時，請使用此技能。該技能提供了模板、最佳實踐和結構化方法，用於創建清晰、適合初學者的文檔。 來源：mamba-mental/agent-skill-manager。

查看原文