Skip to content

Issue Document Creation Guide

本ガイドは、各ソフトウェアコンポーネントの backlog/issues/ 配下に作成する課題・不具合管理ファイル(ISSUE-XXX.md)の記述内容とMarkdownテンプレートを定義するものです。

Purpose & Section Guidelines

1. 目的と対象

  • 仕様として定まっていない課題、懸念事項、およびリリース後に発生した不具合報告を記録・追跡管理します。

2. 命名規則・フロントマター

  • ファイル名: ISSUE-XXX.md の形式で連番により管理(例: ISSUE-001.md)。
  • ステータス値(status)、理由種別(reason)、レビューメタデータ(review)、ライフサイクル遷移、および台帳同期ルールについては、document-status-guide.md を参照してください。

3. セクション構成

  1. 概要: 課題・障害の1行〜簡潔な要約。
  2. 背景・障害内容 (Background & Symptoms): 発生した症状、再現手順、発生環境、または検討が必要な背景。
  3. 原因分析・懸念事項 (Root Cause & Concerns): 発生原因の推測・特定結果、または懸念事項。
  4. 対応方針・作業内容 (Action Plan): 解決のための修正内容や作業項目。
  5. 検証結果 (Verification): 修正確認・解決の検証項目(- [ ])。

Template

以下は課題・不具合管理ファイル(ISSUE-001.md)を作成する際の標準Markdownテンプレートです。

markdown
---
name: ISSUE-001.md
description: <課題または障害の1行概要>
timestamp: YYYY-MM-DD
ai: ai-coauthored
status: DRAFT # DRAFT | REVIEW:DRAFT | TODO | WIP | REVIEW:WIP | DONE | CLOSE
reason: defect # feature | defect | security | spec-change | investigation | performance | refactor | ops
review:
  result: "" # ACCEPTED | REJECTED
  timestamp: "" # YYYY-MM-DD
  reason: "" # REJECTED時の1行理由サマリー
---

# Issue: ISSUE-001 - <課題/不具合件名>

## 概要

<課題や不具合報告の全体概要を記述します。>

## 背景・障害内容

-   **現象**: <発生した現象や問題点を記述>
-   **再現手順**:
    1.  ログイン画面にアクセスする
    2.  特殊文字を含むパスワードを入力して送信する
    3.  500 Internal Server Error が発生する

## 原因分析・懸念事項

<調査により判明した根本原因、または仕様未決定によるリスク・懸念事項を記述します。>

## 対応方針・作業内容

- [ ] パスワード入力値のサニタイズ処理を追加する。
- [ ] 例外発生時の適切なエラーメッセージ返却処理を実装する。

## 検証結果

- [ ] 特殊文字を含むパスワードで正常にログイン処理が完了することを確認。