Document Implementation Guide
開発・実装ドキュメント(<root>/docs/[<group>/]<component>/backlog/)の作成規約および運用ルールを定義します。
Overview
本ガイドは、機能仕様書(SPEC-XXX.md)に基づく実装計画の作成、実装タスクの分解方法、IDの命名規則、および実装タスク詳細ファイルの管理手順を定義するものです(※ 各ドキュメントのステータス定義・ライフサイクル遷移は document-status-guide.md を参照)。
docs/backlog/implementations/ (実装計画)
各増分機能仕様書(incremental specification)に対応した実装計画ファイルは、<root>/docs/backlog/implementations/ 配下に集約して作成・保存します。複数コンポーネント間でのファイル名衝突を防ぐため、ファイル名先頭にソフトウェアコンポーネントの AppID(例: webui-)を付与します。実装計画は Incremental Specification に対して必ず1つ(1:1:1) 作成され、Incremental型 と Track型(計画分割) があります。Track型は実装計画の中で Track 階層をつけて扱います。ファイル名は <AppID>-<SPEC-I-ID>.md となります。詳細な記述仕様、ステータス管理、セクション構成、およびテンプレートについては backlog-implementation-guide.md を参照してください。
tasks/ (実装タスク詳細)
実装計画に対応する実装タスク詳細ファイルは、増分仕様ごとに必ず1つ(1:1:1)作成し、<root>/docs/[<group>/]<component>/backlog/tasks/<SPEC-I-ID>.md としてフラットに配置・管理します。実装計画と同様に Incremental型 と Track型 があり、Track型はタスク詳細ファイル内に Track 階層を設けます。詳細な作成ルール、フロントマター属性、セクション構成、およびテンプレートについては backlog-task-guide.md を参照してください。
backlog/spec.md (仕様実装ステータス台帳・自動生成)
backlog/spec.md は、各ソフトウェアコンポーネント(<root>/docs/[<group>/]<component>/backlog/spec.md)におけるすべての機能仕様書(SPEC-XXX.md)の実装ステータスを一覧管理する台帳ビューです。本ファイルは backlog/status.tsv および specs/ 配下の機能仕様書に基づき、Python スクリプト(mise run aidev:backlog:sync)により自動生成されます。
セクション構成と記述ルール
本台帳は機能仕様の一覧表のみで構成します。
| SpecID | 概要 | ステータス | 更新日 |
|---|---|---|---|
SPEC-001 | サンプル機能仕様 | WIP | 2026-08-09 |
- SpecID: 該当する機能仕様書(
SPEC-XXX.md)へのリンクを設定します。 - 概要: 機能仕様書のフロントマターに記載された
descriptionを記述します。 - ステータス:
backlog/status.tsvに記録された機能仕様書のステータス(DRAFT→REVIEW:DRAFT→TODO→WIP→REVIEW:WIP→DONE|CLOSE)を表示します。 - 更新日:
backlog/status.tsvの更新日(YYYY-MM-DD)を表示します。
backlog/status.tsv (仕様ステータス管理台帳)
backlog/status.tsv は、各ソフトウェアコンポーネントにおける機能仕様書(SPEC-XXX)および増分機能仕様書(SPEC-I-XXX)の実装ステータスを一元管理する正本台帳ファイルです。
- 形式: KVTsv形式(
Key\tValue\tCreated\tUpdated) - 列構成:
Key: 仕様ID(<SPEC-ID>または<SPEC-I-ID>、例:SPEC-001,SPEC-I-001)Value: 最新ステータス(DRAFT,REVIEW:DRAFT,TODO,WIP,REVIEW:WIP,DONE,CLOSE)Created: 初回登録日時(ISO 8601、自動設定)Updated: 最終更新日時(ISO 8601、自動設定)
- 操作方法:
- ステータスの更新は
mise run aidev:kv-tsv -- set <path/to/status.tsv> <ID> <status>(AIDEV-TOOL-28)を使用して行います。 - ステータス変更後は
mise run aidev:backlog:sync(AIDEV-TOOL-29)を実行してspec.mdおよびwbs.mdに反映します。
- ステータスの更新は
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/)を一覧管理する総合台帳ビューです。本ファイルは backlog/status.tsv、tasks/、issues/、todos/、および specs/incremental/ に基づき、Python スクリプト(mise run aidev:backlog:sync)により自動生成されます。
Important
ステータス同期の原則:
tasks/,issues/,todos/や実装計画等のステータスを変更・更新する際は、必ずupdate-document-statusスキル を使用してフロントマターおよびbacklog/status.tsvを更新し、mise run aidev:backlog:syncによりwbs.mdとspec.mdを自動同期してください(手作業による不整合の防止)。
セクション構成と記述順序
以下の順序でセクションを作成し、各カテゴリの台帳テーブルを記述します。
- タスク (
tasks/配下の台帳) - 課題 (
issues/配下の台帳) - TODO (
todos/配下の台帳)
台帳テーブルフォーマット
1. タスク台帳
| ID | 概要 | ステータス | 更新日 | SPEC-I | SPEC-I状態 | SPEC-I更新日 |
|---|---|---|---|---|---|---|
SPEC-I-001 | サンプル実装タスク | WIP | 2026-08-09 | SPEC-I-001 | WIP | 2026-08-09 |
- ID: 該当するタスク詳細ファイル(
tasks/<SPEC-I-ID>.md)へのリンクを設定します。 - 概要: タスク詳細ファイルのフロントマターの
descriptionを記述します。 - ステータス: タスク詳細ファイルのフロントマターの
statusを記述します。 - 更新日: タスク詳細ファイルの更新日(
YYYY-MM-DD)を記述します。 - SPEC-I: 該当する増分仕様書(
../specs/incremental/<SPEC-I-ID>.md)へのリンクを設定します(存在しない場合は-)。 - SPEC-I状態:
backlog/status.tsvに記録された該当増分仕様書のステータスを表示します。 - SPEC-I更新日:
backlog/status.tsvに記録された該当増分仕様書の更新日(YYYY-MM-DD)を表示します。
2. 課題台帳
| ID | 概要 | ステータス | 更新日 |
|---|---|---|---|
ISSUE-001 | サンプル課題 | DRAFT | 2026-08-09 |
- ID: 該当する課題管理ファイル(
issues/ISSUE-XXX.md)へのリンクを設定します。 - 概要: 課題管理ファイルのフロントマターの
descriptionを記述します。 - ステータス: 課題管理ファイルのフロントマターの
statusを記述します。 - 更新日: 課題管理ファイルの更新日(
YYYY-MM-DD)を記述します。
3. TODO台帳
| ID | 概要 | ステータス | 更新日 |
|---|---|---|---|
TODO-001 | サンプルTODO | DRAFT | 2026-08-09 |
- ID: 該当するTODO管理ファイル(
todos/TODO-XXX.md)へのリンクを設定します。 - 概要: TODO管理ファイルのフロントマターの
descriptionを記述します。 - ステータス: TODO管理ファイルのフロントマターの
statusを記述します。 - 更新日: TODO管理ファイルの更新日(
YYYY-MM-DD)を記述します。