documentation について
プロジェクト文書の作成ガイドラインを提供するスキルです。文書の書き方を統一したい開発者向けに、README、変更履歴、アーキテクチャ決定記録、コードコメント、API 仕様を扱い、詳細は別のリファレンスにまとめています。
主な機能
- 01README の内容ガイド
- 02変更履歴の形式ガイド
- 03アーキテクチャ決定記録の指針
- 04コードコメントの原則
- 05API 仕様の指針
活用シーン
- 01プロジェクト README の作成
- 02構造化された変更履歴の管理
- 03重要なアーキテクチャ決定の記録
- 04API 仕様の改善
インストール
コマンドをコピーしてターミナルで実行します。
$
npx skills add https:/インストール後、Claude Code で/documentationを入力して読み込まれたか確認します。
同梱ファイルREFERENCE.md
詳細
ドキュメント
このスキルでは、ドキュメントのガイドラインと標準を定めています。
詳細については、@REFERENCE.md を参照してください。
クイックリファレンス
- README：インストール、クイックスタート、設定、コマンド
- CHANGELOG：Keep a Changelog 形式
- ADR：重要な決定事項に関するアーキテクチャ決定記録
- コード：コメントでは「何を」ではなく「なぜ」を説明します
- API：OpenAPI／Swagger 仕様
コメント
Markdown 対応