bkit-templates

bkit ドキュメントテンプレート

PDCA ドキュメントを作成する際に、これらのテンプレートを使用してください。

利用可能なテンプレート

PDCA（機能ごと、9 フェーズ）

テンプレート	パス	目的
計画	${CLAUDE_PLUGIN_ROOT}/templates/plan.template.md	機能の計画
設計	${CLAUDE_PLUGIN_ROOT}/templates/design.template.md	技術設計
分析	${CLAUDE_PLUGIN_ROOT}/templates/analysis.template.md	ギャップ分析
レポート	${CLAUDE_PLUGIN_ROOT}/templates/report.template.md	完了レポート
インデックス	${CLAUDE_PLUGIN_ROOT}/templates/_INDEX.template.md	ドキュメントインデックス
CLAUDE	${CLAUDE_PLUGIN_ROOT}/templates/CLAUDE.template.md	CLAUDE.md テンプレート

Sprint（複数機能のコンテナ、8 フェーズ、v2.1.13）

テンプレート	パス	目的
マスタープラン	${CLAUDE_PLUGIN_ROOT}/templates/sprint/master-plan.template.md	Sprint の範囲 + 機能 + 依存関係グラフ + Trust の範囲
PRD	${CLAUDE_PLUGIN_ROOT}/templates/sprint/prd.template.md	Sprint レベルの製品要件
計画	${CLAUDE_PLUGIN_ROOT}/templates/sprint/plan.template.md	Sprint 計画（機能ごとの計画を統合）
設計	${CLAUDE_PLUGIN_ROOT}/templates/sprint/design.template.md	Sprint レベルの技術設計
反復	${CLAUDE_PLUGIN_ROOT}/templates/sprint/iterate.template.md	反復ログ + iterateHistory
QA	${CLAUDE_PLUGIN_ROOT}/templates/sprint/qa.template.md	7 層の dataFlowIntegrity（S1）レポート
レポート	${CLAUDE_PLUGIN_ROOT}/templates/sprint/report.template.md	Sprint の完了状況 + KPI + 持ち越し項目

テンプレートの使用方法

計画テンプレート

設計前の機能計画を行うPlan フェーズ用です。

主なセクション：

• 概要と目的
• 範囲（対象／対象外）
• 要件（機能／非機能）
• 成功基準
• リスクと緩和策

設計テンプレート

実装前の技術設計を行うDo フェーズ用です。

主なセクション：

• アーキテクチャ（図、データフロー）
• データモデル（エンティティ、関係）
• API 仕様（エンドポイント、リクエスト／レスポンス）
• UI/UX 設計（レイアウト、コンポーネント）
• エラー処理
• セキュリティに関する考慮事項
• テスト計画
• 実装ガイド

分析テンプレート

設計と実装のギャップ分析を行うCheck フェーズ用です。

主なセクション：

• 設計と実装の比較
• 不足している機能
• 不整合
• 品質指標
• 推奨事項

レポートテンプレート

完了レポートと教訓の整理を行うAct フェーズ用です。

主なセクション：

• 完了した作業の概要
• 指標（LOC、テストカバレッジなど）
• 発生した問題
• 教訓
• 今後の改善点

ドキュメントの出力パス

docs/
├── 01-plan/
│   └── features/
│       └── {feature}.plan.md
├── 02-design/
│   └── features/
│       └── {feature}.design.md
├── 03-analysis/
│   └── features/
│       └── {feature}.analysis.md
└── 04-report/
    └── features/
        └── {feature}.report.md

変数の置換

テンプレートでは {variable} 構文を使用します。

• {feature}：機能名
• {date}：作成日（YYYY-MM-DD）
• {author}：ドキュメントの作成者

パイプラインテンプレート

開発パイプラインのフェーズ用の追加テンプレート：

• ${CLAUDE_PLUGIN_ROOT}/templates/pipeline/ ディレクトリ

---

ドキュメント標準

ファイル名の規則

{number}_{english_name}.md      # 01_system_architecture.md
{number}-{english_name}.md      # 01-system-architecture.md
{feature}.{type}.md             # login.design.md

共通ヘッダー

すべてのドキュメントに次の内容を含めてください。

# {Document Title}

> **Summary**: {One-line description}
>
> **Author**: {Name}
> **Created**: {YYYY-MM-DD}
> **Last Modified**: {YYYY-MM-DD}
> **Status**: {Draft | Review | Approved | Deprecated}

---

バージョン管理

ドキュメント内の変更を追跡します。

## Version History

| Version | Date | Changes | Author |
|---------|------|---------|--------|
| 1.0 | 2024-12-01 | Initial draft | Kay |
| 1.1 | 2024-12-05 | Added API spec | Kay |

相互参照

関連ドキュメントをリンクします。

## Related Documents
- Plan: [login.plan.md](../01-plan/features/login.plan.md)
- Design: [login.design.md](../02-design/features/login.design.md)
- Analysis: [login.analysis.md](../03-analysis/features/login.analysis.md)

ステータスの追跡

各フォルダーで _INDEX.md を使用します。

ステータス	意味	Claude の動作
✅ 承認済み	参照として使用	そのまま従う
🔄 進行中	作成中	変更を通知する
⏸️ 保留	一時停止中	確認を求める
❌ 非推奨	無効	無視する

競合の解決

• コードと設計の不一致：コードを正とし、ドキュメントの更新を提案します
• 複数のバージョン：最新バージョンのみを参照します