docs-snapshot

# ドキュメントスナップショット ## 目的 ユーザーや将来の実装者が迷わないように、必要な場合だけドキュメントを作成・更新し、現在の仕様、使い方、制約、検証結果のスナップショットを残す。 ## ドキュメントが必要な場面 - セットアップ手順、依存関係、環境変数、認証方法が変わるとき。 - コマンド、実行方法、サンプルの使い方が変わるとき。 - ユーザーから見える挙動、入出力、制約、エラー対応が変わるとき。 - トラブルシューティングや運用上の注意点を残す価値があるとき。 - 新しいサンプル、機能、ワークフローを追加するとき。 内部実装だけの変更で利用者への影響がない場合は、ドキュメント更新を無理に追加しない。 ## 更新先の選び方 - リポジトリ全体に関わる内容は `README.md` に書く。 - セットアップや共通の注意点は `docs/` 配下の近い文書に書く。 - サンプル固有の内容は、そのサンプルの近くの README やドキュメントに書く。 - 新しい文書を作る場合は、既存の構成から自然に見つけられる場所に置く。 ## スナップショットとして残す内容 - 現在の目的と対象読者。 - セットアップ手順と必要な前提条件。 - 実行コマンド、入力、出力、期待される結果。 - 必要な環境変数や認証手順。 - 既知の制約、注意点、トラブルシューティング。 - 変更時点で確認した検証方法。 ## 守ること - 実装と一致する最新情報だけを書く。 - 古い手順や矛盾した説明を残さない。 - コマンドやパスは、実際のリポジトリ構成に合わせて具体的に書く。 - ドキュメントは簡潔にし、読者が次に何をすればよいか分かる形にする。