setup-project-md

PROJECT.md のセットアップ

概要

一度限りのセットアップです。コードベースの根拠とユーザーが提供するプロダクトの背景情報を組み合わせ、プロジェクトの概要と構成を説明するルートの PROJECT.md を1つ作成します。ユーザーからファイルの再生成または更新を明示的に求められない限り、継続的なメンテナンスのスキルとして扱わないでください。

出力

• 書き込むファイルは、リポジトリルートの PROJECT.md 1つだけです。
• すでに PROJECT.md が存在する場合は、上書き、統合・更新、中止のいずれにするかを一度だけ尋ねてください。黙って上書きしないでください。

ワークフロー

1. コードベースを把握する

システムを正確に説明するために必要な範囲を調べてください。

• ルートのドキュメント：README.md、アーキテクチャのメモ、デプロイ用ドキュメント、環境変数のサンプル（名前のみ。シークレットの値は絶対にコピーしないでください）。
• マニフェストとツール：パッケージマネージャー、ワークスペース、アプリやパッケージの構成、CI、Docker、インフラのエントリーポイント。
• ランタイムの構成：エントリーポイント、ルート、主要なドメインやモジュール、データストア、キュー、外部サービス。
• プロダクトの提供面：Web アプリ、API、CLI、ワーカー、管理画面、ドキュメントサイトなど。実在するものに限ります。

マーケティング上の主張より、リポジトリ内の根拠を優先してください。推測は明確に示してください。

2. ユーザーの背景情報を収集する

コードだけでは完全に把握できないプロダクトの事実について、ユーザーに質問してください。質問はまとめて行い、次の点を確認してください。

• ミッション／解決する課題と対象外とすること。
• 対象ユーザーと主なユースケース。
• ビジネスモデルや提供方法（該当する場合）。
• 現在の段階（プロトタイプ、ベータ版、本番運用）と既知の制約。
• 重要な経緯、担当者、エージェントが見落としがちな決定事項。
• 稼働中のプロダクト、デザイン、課題管理ツールへのリンク（任意）。

ユーザーが最初に概要を提示した場合は、それを活用し、重要な不足情報のみを尋ねてください。ユーザーがヒアリングを希望しない場合は、前提を明記して進めてください。

3. コードと説明を照合する

• 構成、技術スタック、コマンドについては、コードや設定を優先してください。
• 意図、対象ユーザー、ロードマップ、ビジネスの背景については、ユーザーの入力を優先してください。
• 概要に影響する矛盾を見つけた場合は明示し、ユーザーと確認して解決してください。

4. PROJECT.md を作成する

references/template.md を使用してください。該当するセクションを埋め、内容のないセクションは省略してください。品質の基準は次のとおりです。

• 新しいエージェントが一度読めば、プロジェクトの目的、提供面、構成、実行方法を理解できること。
• プロダクトの意図と実装の構成を区別すること。
• 曖昧なアーキテクチャの説明ではなく、具体的なパスやコマンドを記載すること。
• シークレットを記載しないこと。環境変数は名前のみ記載すること。
• 不明な点や作業中の領域について、正直に記載すること。

5. AGENTS.md からリンクする（条件付き）

PROJECT.md の作成後、次の手順を実行してください。

1. ルートの AGENTS.md のみを確認します。
2. 存在しない場合は、リンクを追加せずに終了してください。AGENTS.md を作成しないでください。
3. 存在する場合は、まだ記載されていなければ PROJECT.md への明確なリンクを追加します。
   • 既存の Index／Docs／Related docs セクションを優先してください。
   • そのようなセクションがない場合は、次のような短いセクションを追加してください。## Project docs と、その下の箇条書き： - [PROJECT.md](PROJECT.md) — product and codebase overview
   • 概要全体を AGENTS.md に重複して記載しないでください。
   • 無関係な AGENTS.md の内容は保持してください。

6. 完了を報告する

• 書き込んだパスを伝えてください。
• 目的を一文で要約し、主な提供面と AGENTS.md を更新したか、更新を省略したかを簡潔に報告してください。
• ユーザーから求められない限り、コミットしないでください。

独立性

このスキルは単独で使用します。他のスキルへの言及、リンク、依存を避けてください。参照するのはリポジトリ内のファイル、ユーザーの入力、およびこのスキルの references/ のみです。

対象外

• README.md の置き換えや、アーキテクチャ ADR 全体の作成。
• コードベースの把握中に行う機能の実装やリファクタリング。
• 存在しない AGENTS.md の作成。
• ユーザーから再度セットアップを求められない限り、定期的な監査は行いません。