Skip to content

Implementation Plan Creation Guide

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

File Naming & Section Guidelines

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

実装計画には以下の2つの種別が存在します。

  • feature型 (<AppID>-<USECASE-ID>-<F-ID>-<SPEC-ID>[-<TRACK-ID>].md):
    • 親ユースケース・feature(実装ロードマップ)に紐づく実装計画(例: webui-USECASE-001-F-1-SPEC-001.md)。
    • track: 実装単位(feature)を分割したもの(サブスライス)です。1つの feature に対する実装計画を分割して管理する場合に [-<TRACK-ID>](例: webui-USECASE-001-F-1-SPEC-001-TRACK-1.md)を付与します。
  • specification型 (<AppID>-<SPEC-ID>.md):
    • feature を伴わない、単一コンポーネント内の機能仕様書(SPEC)に基づく実装計画(例: webui-SPEC-001.md)。

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

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

3. 必須セクション構成

  1. 実装内容: 機能仕様を実現するための技術的アプローチ、変更方針、影響範囲を記述します。
  2. 完了条件: 本実装計画が完了したとみなす具体的な受入・達成条件をチェックリスト形式(- [ ])等で記述します。
  3. 実装計画: 実装の作業手順、進行フェーズ、依存関係を記述します。
  4. タスク一覧: 個別の実装タスクを定義する以下のフォーマットのテーブル。

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

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

  • SPEC: 機能仕様書へのリンク(無しの場合は [task:SPEC-001-1](...) または [issue:ISSUE-001](...))。
  • ステータス: 参照先タスク等の最新進行ステータス(DRAFT | REVIEW:DRAFT | TODO | WIP | REVIEW:WIP | DONE | CLOSE)を記述。

Template

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

markdown
---
name: webui-SPEC-001.md
description: <機能仕様SPEC-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-001

## 実装内容

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

## 完了条件

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

## 実装計画

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

## タスク一覧

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