documentation

Documentation

📋 実行前チェック(必須)

このスキルを使うべきか?

• READMEを作成・更新する?
• コードコメントを記述する?
• APIドキュメントを作成する?
• 技術仕様書を作成する?

前提条件

• 読者が誰かを把握しているか?
• 必要な情報を整理したか?
• 既存ドキュメントとの整合性を確認したか?

禁止事項の確認

• コードを見れば分かることをコメントしようとしていないか?
• 古い情報を放置しようとしていないか?
• 読者に必要な情報を省略しようとしていないか?

トリガー

• README作成・更新時
• コードコメント記述時
• APIドキュメント作成時
• 技術仕様書作成時

🚨 鉄則

読者が必要な情報を素早く見つけられる構造にする。

README構造

# プロジェクト名

簡潔な説明(1-2文)

## クイックスタート

npm install && npm start

## 使用例

## 設定

## 開発

## ライセンス

コードコメント

// ❌ 何をしているかの説明(コードで分かる)
// ユーザーIDで検索する
const user = await findById(id);

// ✅ なぜそうしているかの説明
// キャッシュ整合性のため、更新後に再取得
const user = await findById(id);

🚫 禁止事項まとめ

• コードで分かることのコメント
• 古い情報の放置
• 必要な情報の省略
• 構造のないドキュメント