Skip to content

Document Implementation Guide

開発・実装ドキュメント(<root>/docs/[<group>/]<component>/backlog/)の作成規約および運用ルールを定義します。

Overview

本ガイドは、機能仕様書(SPEC-XXX.md)に基づく実装計画の作成、実装タスクの分解方法、IDの命名規則、および実装タスク詳細ファイルの管理手順を定義するものです(※ 各ドキュメントのステータス定義・ライフサイクル遷移は document-status-guide.md を参照)。

docs/backlog/implementations/ (実装計画)

各機能仕様書および feature / Track に対応した実装計画ファイルは、<root>/docs/backlog/implementations/ 配下に集約して作成・保存します。複数コンポーネント間でのファイル名衝突を防ぐため、ファイル名先頭にソフトウェアコンポーネントの AppID(例: webui-)を付与します。実装計画には feature型<AppID>-<USECASE-ID>-<F-ID>-<SPEC-ID>[-<TRACK-ID>].md)と specification型<AppID>-<SPEC-ID>.md)の2種類があります。詳細な記述仕様、ステータス管理、セクション構成、およびテンプレートについては backlog-implementation-guide.md を参照してください。

tasks/ (実装タスク詳細)

実装計画から分解された個別の実装タスクは、詳細ファイルとして <root>/docs/[<group>/]<component>/backlog/tasks/ 配下に保存します。詳細なID命名・作成・分割ルール、フロントマター属性、セクション構成、およびテンプレートについては backlog-task-guide.md を参照してください。

backlog/spec.md (仕様実装ステータス台帳)

backlog/spec.md は、各ソフトウェアコンポーネント(<root>/docs/[<group>/]<component>/backlog/spec.md)におけるすべての機能仕様書(SPEC-XXX.md)の実装状況および増分機能仕様書(feature specification)を一括管理する台帳ファイルです(※ 機能仕様書自体のフロントマターにはステータスを持たせず、本台帳を実装ステータスの単一の信頼できる情報源とします)。

セクション構成と記述ルール

以下の2つの章(見出し)で構成します。

  1. ## specification (機能仕様一覧): コンポーネント内の全機能仕様書(SPEC-XXX.md)の実装ステータスを管理します。

    SpecID概要ステータス更新日
    SPEC-001サンプル機能仕様WIP2026-08-09
    • SpecID: 該当する機能仕様書(SPEC-XXX.md)へのリンクを設定します。
    • 概要: 機能仕様の概要を記述します。
    • ステータス: 機能仕様書のステータス(DRAFTREVIEW:DRAFTTODOWIPREVIEW:WIPDONE | CLOSE)を記述します。
    • 更新日: ステータス変更や更新を行った日付を記述します。
  2. ## feature specification (増分機能仕様一覧): 各機能仕様書に対して増分仕様書(feature specification)が存在する場合、対象仕様書ごとの節(### <SPEC-ID>)を作成し、配下の feature specification 一覧テーブルを記述します。

    markdown
    ## feature specification
    
    ### SPEC-001
    
    | FeatureSpecID | Description |
    | :--- | :--- |
    | [`SPEC-F-001-1`](../specs/SPEC-001/SPEC-F-001-1.md) | ログイン画面バリデーション強化の増分仕様 |
    • FeatureSpecID: 対象の feature specification(SPEC-F-YYY-Z.md)へのリンクを設定します。
    • Description: feature specification のフロントマターに記載された description を記述します。

issues/ (課題・不具合管理)

仕様として定まっていない課題、懸念事項、およびリリース後に発生した不具合報告などは、<root>/docs/[<group>/]<component>/backlog/issues/ 配下に作成・管理します。詳細な命名規則、フロントマター属性、セクション構成、およびテンプレートについては backlog-issue-guide.md を参照してください。

todos/ (TODO管理)

SPEC や ISSUE に該当しないが、将来的に検討・実施すべき作業メモや備忘録などは、<root>/docs/[<group>/]<component>/backlog/todos/ 配下に作成・記録します。詳細なステータス管理、昇格(Promotion)ルール、およびテンプレートについては backlog-todo-guide.md を参照してください。

docs/backlog/phase.md (フェーズ別実装ステータス台帳ビュー)

docs/backlog/phase.md は、全体計画(docs/plan.md)の各フェーズに帰属するユースケース、feature、および機能仕様書の実装状況を一覧管理する総合ビューです(詳細は backlog-phase-guide.md を参照)。

backlog/wbs.md (WBS・総合作業台帳)

backlog/wbs.md は、各ソフトウェアコンポーネント(<root>/docs/[<group>/]<component>/backlog/wbs.md)における全タスク(tasks/)、課題(issues/)、TODO(todos/)を一覧管理する総合台帳ファイルです。

IMPORTANT

ステータス同期の原則: tasks/, issues/, todos/ や実装計画等のステータスを変更・更新する際は、必ず update-document-status スキル を使用してフロントマターと台帳(wbs.md や親計画表)を一括同期してください(手作業による不整合の防止)。

セクション構成と記述順序

以下の順序でセクションを作成し、各カテゴリの台帳テーブルを記述します。

  1. タスク (tasks/ 配下の台帳)
  2. 課題 (issues/ 配下の台帳)
  3. TODO (todos/ 配下の台帳)

台帳テーブルフォーマット

3つのセクション共通で、以下の列構成でテーブルを作成・管理します。

ID概要ステータス更新日時
SPEC-001-1サンプル実装タスクWIP2026-08-09
  • ID: 該当する各詳細ファイル(tasks/, issues/, todos/)へのリンクを必須として設定します。
  • 概要: 対象項目の1行概要を記述します。
  • ステータス: 各対象ファイルの最新ステータスを記述します。
  • 更新日時: ステータス変更や更新を行った日時を記述します。