bkit-templates

用途

bkit-templates 用于在生成 PDCA 文档时提供统一模板。它面向按功能推进的开发流程，也面向多功能的 Sprint 容器流程，帮助规范文档结构、内容分区和输出路径。

主要能力

PDCA（按功能，9 阶段）模板

模板	路径	用途
Plan	${CLAUDE_PLUGIN_ROOT}/templates/plan.template.md	功能规划
Design	${CLAUDE_PLUGIN_ROOT}/templates/design.template.md	技术设计
Analysis	${CLAUDE_PLUGIN_ROOT}/templates/analysis.template.md	差距分析
Report	${CLAUDE_PLUGIN_ROOT}/templates/report.template.md	完成报告
Index	${CLAUDE_PLUGIN_ROOT}/templates/_INDEX.template.md	文档索引
CLAUDE	${CLAUDE_PLUGIN_ROOT}/templates/CLAUDE.template.md	CLAUDE.md 模板

Sprint（多功能容器，8 阶段，v2.1.13）模板

模板	路径	用途
Master Plan	${CLAUDE_PLUGIN_ROOT}/templates/sprint/master-plan.template.md	Sprint 范围 + 功能 + 依赖图 + Trust scope
PRD	${CLAUDE_PLUGIN_ROOT}/templates/sprint/prd.template.md	Sprint 级产品需求
Plan	${CLAUDE_PLUGIN_ROOT}/templates/sprint/plan.template.md	Sprint 计划（按功能计划综合）
Design	${CLAUDE_PLUGIN_ROOT}/templates/sprint/design.template.md	Sprint 级技术设计
Iterate	${CLAUDE_PLUGIN_ROOT}/templates/sprint/iterate.template.md	迭代日志 + iterateHistory
QA	${CLAUDE_PLUGIN_ROOT}/templates/sprint/qa.template.md	7-Layer dataFlowIntegrity（S1）报告
Report	${CLAUDE_PLUGIN_ROOT}/templates/sprint/report.template.md	Sprint 完成 + KPI + carry items

使用方式

Plan 模板

用于 Plan 阶段——设计前的功能规划。关键部分包括：

概述与目的
范围（In/Out）
需求（功能性/非功能性）
成功标准
风险与缓解

Design 模板

用于 Do 阶段——实现前的技术设计。关键部分包括：

架构（图表、数据流）
数据模型（实体、关系）
API 规范（端点、请求/响应）
UI/UX 设计（布局、组件）
错误处理
安全考虑
测试计划
实现指南

Analysis 模板

用于 Check 阶段——设计与实现之间的差距分析。关键部分包括：

设计与实现对比
缺失功能
不一致之处
质量指标
建议

Report 模板

用于 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}：文档作者

流水线模板

用于 Development Pipeline 阶段的额外模板：${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 行为
✅ Approved	作为参考使用	按原样遵循
🔄 In Progress	正在编写	通知变更
⏸️ On Hold	暂时暂停	请求确认
❌ Deprecated	不再有效	忽略

冲突解决

代码与设计不一致：以代码为准，建议更新文档
多个版本：仅参考最新版本

适用场景

适用于需要在 Claude 相关开发流程中生成结构化 PDCA 文档或 Sprint 文档的场景，例如功能规划、技术设计、差距分析、完成报告、冲刺规划与需求说明等。

限制

资料未提供模板的具体字段示例、自动化生成流程或与其他工具的集成方式，暂未提供。安装方式、收费、平台等信息暂未提供。