プロジェクト課題と解決アプローチ 作成の指示テンプレート
- 以下のルールに従って、プロジェクト課題と解決アプローチ(Project Issues and Approach) を 1 ファイル作成してください。出力は Markdown とします。
- 目的は、関係者が「何が課題で、どれを、どう解く方針か(なぜその方針か)」を合意できる状態にすることです。
- 設計詳細(DB、API、画面詳細、テストケース列挙など)は書きません。
- 曖昧表現(例:「適切に」「可能な限り」「十分に」)は禁止です。
- “事実/観察” と “推測/仮説” を混ぜないでください(混ざる場合はラベルで区別)。
- 解決策候補は最低 2 案を挙げ、採用理由(判断軸)を明記してください。
事前に与えられる情報(入力)
次の情報が与えられている前提で、それに整合する文書を作成してください(不明な場合は「未確定」としてよい)。
- プロジェクト名
- 課題一覧(課題、影響、優先度)
- 原因(事実と仮説を区別)
- 解決策候補(最低 2 案)
- 採用アプローチ(採用案、採用理由、採用しない案と理由)
- トレードオフ/リスク(任意)
- 次の検討事項(ToDo)(任意)
ファイル構成(推奨)
プロジェクト単位のフォルダ配下に置きます。
docs/ja/project-docs/prj-0001/030-プロジェクト課題と解決アプローチ/030-プロジェクト課題と解決アプローチ-<プロジェクト名>.md
※ 配置や章フォルダの考え方は docs/ja/handbook/guidelines/docs-structure-guide.md も参照してください。
YAML Frontmatter(推奨)
機械可読性が必要な場合は、先頭に YAML Frontmatter を付与してください(id / type / title / status は必須)。
yaml
---
id: prj-0001-issues-and-approach
type: project
title: プロジェクト課題と解決アプローチ: <プロジェクト名>
status: draft # draft / ready / deprecated
based_on: []
supersedes: []
---idはprj-<projectNo>-issues-and-approachを推奨します(例:prj-0001-issues-and-approach)。typeはproject固定です。based_onは、根拠として直接参照するものがある場合のみ列挙します(なければ[])。
出力フォーマット(必須)
次の見出しをこの順序で含めてください。
- 課題一覧
- 原因(仮説でも可)
- 解決策候補
- 採用アプローチと理由
- トレードオフ/リスク(任意)
- 次の検討事項(ToDo)(任意)
記述ルール(重要)
- 課題は「困っている現象」を書く。解決策の先取り(例:「自動発注がない」)は禁止。
- 課題には最低限「影響」と「優先度」を含める(表形式推奨)。
- 原因は事実と仮説を分ける(例:
(事実)/(仮説)を付ける)。 - 解決策候補は最低 2 案。各案は 1〜3 行で概要を書く。
- 採用アプローチでは、採用案と採用理由を判断軸で説明する。
- 判断軸の例: 効果/コスト/期間/リスク/現場適合
- 採用しない案がある場合は、採用しない理由も 1 行で添える。
- トレードオフ/リスクは「起きうること」と「軽減策」をセットで書く。