bkit-templates

Compare original and translation side by side

🇺🇸

Original

English

🇨🇳

Translation

Chinese

bkit Document Templates

bkit 文档模板

Use these templates when generating PDCA documents.

生成PDCA文档时请使用这些模板。

Available Templates

可用模板

Template	Path	Purpose
Plan	`${CLAUDE_PLUGIN_ROOT}/templates/plan.template.md`	Feature planning
Design	`${CLAUDE_PLUGIN_ROOT}/templates/design.template.md`	Technical design
Analysis	`${CLAUDE_PLUGIN_ROOT}/templates/analysis.template.md`	Gap analysis
Report	`${CLAUDE_PLUGIN_ROOT}/templates/report.template.md`	Completion report
Index	`${CLAUDE_PLUGIN_ROOT}/templates/_INDEX.template.md`	Document index
CLAUDE	`${CLAUDE_PLUGIN_ROOT}/templates/CLAUDE.template.md`	CLAUDE.md template

模板类型	路径	用途
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模板

Template Usage

模板使用说明

Plan Template

Plan模板

For Plan phase - feature planning before design.

Key sections:

Overview & Purpose
Scope (In/Out)
Requirements (Functional/Non-Functional)
Success Criteria
Risks & Mitigation

适用于Plan阶段 - 设计前的功能规划。

核心章节：

概述与目标
范围（包含/排除）
需求（功能/非功能）
成功标准
风险与应对措施

Design Template

Design模板

For Do phase - technical design before implementation.

Key sections:

Architecture (diagrams, data flow)
Data Model (entities, relationships)
API Specification (endpoints, request/response)
UI/UX Design (layouts, components)
Error Handling
Security Considerations
Test Plan
Implementation Guide

适用于Do阶段 - 开发前的技术设计。

核心章节：

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

Analysis Template

Analysis模板

For Check phase - gap analysis between design and implementation.

Key sections:

Design vs Implementation comparison
Missing features
Inconsistencies
Quality metrics
Recommendations

适用于Check阶段 - 设计与实现之间的差距分析。

核心章节：

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

Report Template

Report模板

For Act phase - completion report and lessons learned.

Key sections:

Summary of completed work
Metrics (LOC, test coverage, etc.)
Issues encountered
Lessons learned
Future improvements

适用于Act阶段 - 完成报告与经验总结。

核心章节：

已完成工作摘要
指标（代码行数、测试覆盖率等）
遇到的问题
经验教训
未来改进方向

Document Output Paths

文档输出路径

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

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 Substitution

变量替换

Templates use

{variable}

syntax:

```
{feature}
```
: Feature name
```
{date}
```
: Creation date (YYYY-MM-DD)
```
{author}
```
: Document author

模板使用

{variable}

语法：

```
{feature}
```
：功能名称
```
{date}
```
：创建日期（YYYY-MM-DD）
```
{author}
```
：文档作者

Pipeline Templates

流水线模板

Additional templates for Development Pipeline phases:

${CLAUDE_PLUGIN_ROOT}/templates/pipeline/

Document Standards

文档标准

File Naming Rules

文件命名规则

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

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

Common Header

通用页眉

All documents should include:

markdown

undefined

所有文档应包含：

markdown

undefined

{Document Title}

{文档标题}

Summary: {One-line description}

Author: {Name} Created: {YYYY-MM-DD} Last Modified: {YYYY-MM-DD} Status: {Draft | Review | Approved | Deprecated}

undefined

摘要：{一句话描述}

作者：{姓名} 创建日期：{YYYY-MM-DD} 最后修改：{YYYY-MM-DD} 状态：{草稿 | 审核中 | 已批准 | 已废弃}

undefined

Version Control

版本控制

Track changes within documents:

markdown

undefined

在文档内跟踪变更：

markdown

undefined

Version History

版本历史

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

undefined

版本	日期	变更内容	作者
1.0	2024-12-01	初始草稿	Kay
1.1	2024-12-05	添加API规范	Kay

undefined

Cross-References

交叉引用

Link related documents:

markdown

undefined

关联相关文档：

markdown

undefined

Status	Meaning	Claude Behavior
✅ Approved	Use as reference	Follow as-is
🔄 In Progress	Being written	Notify of changes
⏸️ On Hold	Temporarily paused	Request confirmation
❌ Deprecated	No longer valid	Ignore

状态	含义	Claude 行为
✅ 已批准	作为参考使用	严格遵循
🔄 进行中	编写中	通知变更情况
⏸️ 暂停	临时搁置	请求确认
❌ 已废弃	不再有效	忽略

bkit-templates

Original

Translation

bkit Document Templates

bkit 文档模板

Available Templates

可用模板

Template Usage

模板使用说明

Plan Template

Plan模板

Design Template

Design模板

Analysis Template

Analysis模板

Report Template

Report模板

Document Output Paths

文档输出路径

Variable Substitution

变量替换

Pipeline Templates

流水线模板

Document Standards

文档标准

File Naming Rules

文件命名规则

Common Header

通用页眉

{Document Title}

{文档标题}

Version Control

版本控制

Version History

版本历史

Cross-References

交叉引用

Related Documents

相关文档

Status Tracking

状态跟踪

Conflict Resolution

冲突解决