Skip to content

Implementation Roadmap Creation Guide

本ガイドは、複数のソフトウェアコンポーネントが関連・連携する横断的開発を管理するために <root>/docs/backlog/roadmaps/ 配下に作成する「実装ロードマップ」の記述内容とMarkdownテンプレートを定義するものです( 非追跡対象 )。

概念定義(feature, スライス, Track)

  • 実装単位 (feature): 動作する機能の最小単位(kebab-case)。推奨粒度は 「関連する各ソフトウェアコンポーネントの仕様(SPEC)が1つずつ程度」 とします。
  • スライス (実装ロードマップ): 実装時の一時的な分割・計画情報。各実装ロードマップファイル(docs/backlog/roadmaps/<feature-name>.md)が1つのスライスを表します( 非追跡対象 )。
  • Track (サブスライス): 実装単位(feature)を分割したもの(サブスライス)。1つの feature に対する実装計画を分割して管理する単位です。
  • 実装計画の参照規則: 本ロードマップで参照する各コンポーネントの実装計画は feature型 となり、ファイル名・ID は <AppID>-<USECASE-ID>-<F-ID>-<SPEC-ID>[-<TRACK-ID>](例: AUTH-SERVICE-USECASE-001-F-1-SPEC-001.md, AUTH-SERVICE-USECASE-001-F-1-SPEC-001-TRACK-1.md)とします。
  • 単方向参照規則: 実装ロードマップからは、親ユースケース(docs/usecases/USECASE-XXX.md)および対象 feature(<UseCaseID>:<FeatureID> 形式。例: USECASE-001:F-1)への参照(リンク)をヘッダー等に記述します。なお、ユースケースから非追跡対象の実装ロードマップへの参照は行いません。

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

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

Section & Column Guidelines

ロードマップファイルには以下の4つのセクションを必ず記述します。

1. 概要 (Overview)

  • 複数コンポーネントにまたがる横断的開発の概要とアプローチを記述します。

2. 目的 (Purpose)

  • 本ロードマップで達成すべき全体目標や価値を記述します。

3. 完了条件 (Completion Criteria)

  • 本ロードマップ(スライス)全体が完了したとみなす具体的な達成条件をチェックリスト形式(- [ ])等で記述します。

4. 実装計画表 (Roadmap Table)

  • 関連する各コンポーネントの実装計画を管理するテーブルを以下の列フォーマットで記述します。
    • AppID: ソフトウェアコンポーネントの AppID (※ <root>/GEMINI.project.md で定義されたAppID)
    • 概要: 該当コンポーネントでの実装概要
    • 実装計画: 実装計画ファイル(docs/backlog/implementations/<AppID>-<USECASE-ID>-<F-ID>-<SPEC-ID>[-<TRACK-ID>].md 等)へのリンク
    • ステータス: 開発進行に応じたステータス(SPECDESIGNPLANTODO | WIP | REVIEW:WIP | DONE | CLOSE)を記述します(※ 不具合対応等で仕様書・設計書が不要な場合は PLAN または TODO から開始)。
    • 依存: 前提となる依存対象を <AppID>:<実装計画> の形式(例: USER-SERVICE:USECASE-001-F-1-SPEC-002)で記述(依存がない場合は NONE
    • 更新日時: 最終更新日時(YYYY-MM-DD HH:mm)

Template

以下は実装ロードマップを作成する際の標準Markdownテンプレートです。

markdown
---
name: roadmap-auth-feature.md
description: <実装ロードマップの1行概要>
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 Roadmap: <機能・プロジェクト名>

**親ユースケース**: [`USECASE-001`](../../usecases/USECASE-001.md)
**対象 Feature**: `USECASE-001:F-1` (`user-login`)

## 概要

<複数ソフトウェアコンポーネントを横断する開発の概要を記述します。>

## 目的

<本ロードマップにより達成される全体ゴールやビジネス/技術的価値を記述します。>

## 完了条件

-   [ ] <スライス全体の完了条件1>
-   [ ] <スライス全体の完了条件2>

## 実装計画表

| AppID | 概要 | 実装計画 | ステータス | 依存 | 更新日時 |
| :--- | :--- | :--- | :--- | :--- | :--- |
| `AUTH-SERVICE` | 認証トークン発行API実装 | [`AUTH-SERVICE-USECASE-001-F-1-SPEC-001`](../implementations/AUTH-SERVICE-USECASE-001-F-1-SPEC-001.md) | WIP | `USER-SERVICE:USECASE-001-F-1-SPEC-002` | 2026-08-09 |
| `USER-SERVICE` | ユーザー情報参照API拡張 | [`USER-SERVICE-USECASE-001-F-1-SPEC-002`](../implementations/USER-SERVICE-USECASE-001-F-1-SPEC-002.md) | DONE | NONE | 2026-08-09 |