プロジェクト概要 作成の指示テンプレート
- 以下のルールに従って、プロジェクト概要(Project Overview) を 1 ファイル作成してください。出力は Markdown とします。
- 目的は、関係者が「なぜやるのか(背景/目的/必要性/期待効果/前提条件)」を合意できる状態にすることです。
- 設計詳細(DB、API、画面詳細、テストケース列挙など)は書きません。
- 曖昧表現(例:「適切に」「可能な限り」「十分に」)は禁止です。
- 数値目標は、根拠や測定方法が不明なら無理に置かず、「未確定」 と明記してください。
事前に与えられる情報(入力)
次の情報が与えられている前提で、それに整合する文書を作成してください(不明な場合は「未確定」としてよい)。
- プロジェクト名
- 背景(現状、困りごと、発生している問題)
- 目的(達成したい状態)
- 必要性(なぜ今やる必要があるか)
- 期待効果(定量/定性。可能なら指標)
- 前提条件(変えないこと/依存条件/制約)
- 関係者メモ(意思決定者、合意が必要な点、未確定事項など)
YAML Frontmatter(推奨)
機械可読性が必要な場合は、先頭に YAML Frontmatter を付与してください(id / type / title / status は必須)。
yaml
---
id: prj-0001-overview
type: project
title: プロジェクト概要: <プロジェクト名>
status: draft # draft / ready / deprecated
based_on: []
supersedes: []
---idはprj-<projectNo>-overviewを推奨します(例:prj-0001-overview)。typeはproject固定です。based_onは、既存の経営方針・制度資料・過去 ADR など、根拠として直接参照するものがある場合のみ列挙します(なければ[])。
出力フォーマット(必須)
プロジェクト概要
次の見出しをこの順序で含めてください。
- 背景
- 目的
- 必要性
- 期待効果
- 前提条件
- 関係者メモ(任意)
記述ルール(重要)
- 背景は「現状」と「問題」を区別して書く。
- 目的は「改善する」ではなく「改善後の状態」を書く。
- 必要性は、期限/放置リスク/外部要因/属人化など「今やる理由」を明確にする。
- 期待効果は、可能なら「指標/現状/目標/測定方法」を最小セットで書く(不明なら「未確定」)。
- 前提条件は「変えない前提」と「依存前提」を区別して書く。