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。