Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Implementation Plan Creation Guide

本ガイドは、<root>/docs/backlog/implementations/ 配下に集約して作成する実装計画の記述内容とMarkdownテンプレートを定義するものです( 非追跡対象 )。複数コンポーネント間でのファイル名衝突を防ぐため、ファイル名先頭にソフトウェアコンポーネントの AppID(例: webui)を付与します。

File Naming & Section Guidelines

1. 実装計画の種別とファイル名規則

すべての実装計画は Incremental Specification(SPEC-I-ID)に対応して作成 され、Incremental Specification と実装計画、タスク詳細ファイルは 1:1:1 の関係 となります。実装計画には以下の 2つの種別 がありますが、いずれの種別でも実装計画ファイルは1つの Incremental Spec に対して必ず1つ となります。

  1. Incremental 型:
    • 1つの SPEC-I に対し、計画分割を行わずに単一の計画手順で完結する場合。
  2. Track 型(計画分割):
    • 1つの SPEC-I の作業規模が大きく、実装手順を段階化(Track)して進める場合。Track ごとにファイルを分割せず、実装計画ファイルの中に Track 階層を設けて扱います
  • ファイル名規則:
    • <AppID>-<SPEC-I-ID>.md(例: webui-SPEC-I-001.md
  • 作成省略と上位ステータス不変ルール:
    • 契約に変更のない仕様変更・不具合修正・脆弱性修正・リファクタリング・パフォーマンス改善で、変更対象が1ファイルかつ10行以下の場合は、実装計画を作成せずに作業 します(既存タスク詳細の実装メモに記録)。
    • 複数ファイルまたは11行以上で既存タスク詳細を WIP に戻して改修する場合も、実装計画など上位ドキュメントのステータスは変更しません

2. フロントマターとステータス管理

  • 標準項目(name, description, timestamp, ai)に加え、status, review キーを記述します。
  • ステータス値(status)、レビューメタデータ(review)、ライフサイクル遷移、完了条件評価、および台帳同期ルールについては、document-status-guide.md を参照してください。

3. 必須セクション構成

  1. 実装内容: 機能仕様を実現するための技術的アプローチ、変更方針、影響範囲を記述します。
  2. 完了条件: 本実装計画が完了したとみなす具体的な受入・達成条件をチェックリスト形式(- [ ])等で記述します。
  3. 実装計画: 実装の作業手順、進行フェーズ、依存関係を記述します。Track型の場合は本セクション内に Track 階層(### Track 1: ... 等)を設けて記述します。
  4. タスク一覧: 対応するタスク詳細ファイル(<component>/backlog/tasks/<SPEC-I-ID>.md)へのリンクおよび進行状況を管理するテーブル。Track型の場合は Track 階層ごとのサブテーブルまたはセクションを設けて管理します。

4. 実装タスク一覧テーブルフォーマット

TaskID | 概要 | SPEC | ステータス | 依存 | 更新日時

  • TaskID: 各コンポーネントのタスク詳細ファイル(<component>/backlog/tasks/<SPEC-I-ID>.md)へのリンク。
  • SPEC: 対応する増分機能仕様書(specs/incremental/<SPEC-I-ID>.md)へのリンク。
  • ステータス: 参照先タスク等の最新進行ステータス(DRAFT | REVIEW:DRAFT | TODO | WIP | REVIEW:WIP | DONE | CLOSE)を記述。

Template

以下は実装計画(webui-SPEC-I-001.md)を作成する際の標準Markdownテンプレートです。

---
name: webui-SPEC-I-001.md
description: <増分機能仕様SPEC-I-001に基づく実装計画方針>
timestamp: YYYY-MM-DD
ai: ai-coauthored
status: DRAFT # DRAFT | REVIEW:DRAFT | TODO | WIP | REVIEW:WIP | DONE
review:
  result: "" # ACCEPTED | REJECTED
  timestamp: "" # YYYY-MM-DD
  reason: "" # REJECTED時の1行理由サマリー
---

# Implementation Plan: webui-SPEC-I-001

## 実装内容

<本機能仕様を実現するための実装アプローチ、モジュール追加・修正方針、影響範囲を記述します。>

## 完了条件

-   [ ] <本コンポーネントにおける実装の完了条件1>
-   [ ] <本コンポーネントにおける実装の完了条件2>

## 実装計画

1.  データモデルおよびリポジトリ層の実装
2.  サービスロジックおよびバリデーション処理の実装
3.  API エンドポイントの実装と単体/結合テスト作成

## タスク一覧

| TaskID | 概要 | SPEC | ステータス | 依存 | 更新日時 |
| :--- | :--- | :--- | :--- | :--- | :--- |
| [`SPEC-I-001`](../../frontend/webui/backlog/tasks/SPEC-I-001.md) | 認証トークン生成・ログインAPI実装 | [`SPEC-I-001`](../../frontend/webui/specs/incremental/SPEC-I-001.md) | WIP | NONE | 2026-09-03 |