Work Documentation

Appearance

TODO Document Creation Guide ​

本ガイドは、各ソフトウェアコンポーネントの backlog/todos/ 配下に作成する TODO 管理ファイル（TODO-XXX.md）の記述内容とMarkdownテンプレートを定義するものです。

Purpose & Rule Guidelines ​

1. 目的と対象 ​

  • SPEC（機能仕様）や ISSUE（課題・不具合）に該当しないが、将来的に検討・実施すべき簡易な作業メモ、改善アイデア、備忘録等を記録します。

2. ステータス管理と昇格ルール ​

  • TODO のステータス値（status）、レビューメタデータ（review）、ライフサイクル遷移、SPEC/ISSUE への昇格（Promotion）ルール、および台帳同期については、document-status-guide.md を参照してください。

Template ​

以下は TODO 管理ファイル（TODO-001.md）を作成する際の標準Markdownテンプレートです。

markdown
---
name: TODO-001.md
description: <TODO項目の1行概要>
timestamp: YYYY-MM-DD
ai: ai-coauthored
status: DRAFT # DRAFT | REVIEW:DRAFT | TODO | CLOSE
review:
  result: "" # ACCEPTED | REJECTED
  timestamp: "" # YYYY-MM-DD
  reason: "" # REJECTED時の1行理由サマリー
---

# TODO: TODO-001 - <TODO件名>

## 概要

<将来的に検討・実施したい作業メモやアイデアの概要を記述します。>

## 詳細・検討事項

<具体的なメモ内容、検討すべきポイント、関連コード箇所等を記述します。>

## 昇格ステータス (Promotion Status)

-   **昇格先**: 未定 / [`SPEC-003`](../specs/SPEC-003.md) / [`ISSUE-002`](../issues/ISSUE-002.md)
-   **メモ**: SPEC-003 策定時に本項目の要件を取り込むため昇格。昇格完了時に status を CLOSE に更新する。