本文へスキップ
SpecifyDocs

活用ガイド

APIドキュメントを最新に保つ

コードとAPI説明を照合し、接続した文書の直接更新をリクエスト・レスポンス・例と併せて確認します。

APIコードと文書のリクエスト・レスポンスが異なる場合は、現在の実装を読み、接続したドキュメントの次の更新まで確認します。

資料を準備する

ルート、ハンドラー、スキーマがあるGitHubリポジトリとブランチを準備します。既存のAPIドキュメントと読者も決めます。認証情報や本番シークレットの実際の値は記載しません。

Mammaの実際のコードから作成したプロジェクト概要
文書でコードの根拠と主要な構成要素を確認します。

生成してレビューする

チャットでリポジトリを読み、APIリファレンスを作成するよう依頼します。呼び出しの流れが分かりにくい場合は、クライアント・サーバー・外部サービスの図も依頼します。パス、メソッド、必須項目、ステータスコード、認証・権限、ページネーション、エラー、例を実際のハンドラー・スキーマ・テストと照合します。

コード変更後に更新する

更新したい既存ドキュメントやキャンバスにリポジトリとブランチを接続します。そのブランチへのpushにより、接続先を直接編集する実行が始まる場合があります。更新後の本文と履歴で反映内容を確認します。一緒に維持するほかのガイドも、それぞれリポジトリに接続してください。

チャットへの依頼例

APIリポジトリの現在のブランチを読み、注文作成APIの文書を作成して。
リクエスト・レスポンス・エラー・権限・例を根拠のファイルパスとともにまとめて。
未確認の動作は未確認とし、呼び出しの流れも説明して。
既存の連携に影響する変更は、移行案内と告知範囲を人が判断します。実装を変える際は改善ドキュメントを作り、コーディングエージェントにMCPで読ませます。push後に接続した文書を再確認します。

GitHub · MCP