mcpField
B
bkit-templates

bkit-templates

github.com/ww-w-ai文档处理60653 次安装4 周前更新
代码仓库

关于 bkit-templates

用于生成 bkit PDCA 和 Sprint 文档的模板集合，覆盖功能规划到完成报告，并提供记录和跟踪工作的结构化章节与规范。

主要功能

  1. 01按功能划分的九阶段 PDCA 模板
  2. 02八阶段 Sprint 模板
  3. 03规划、设计、分析与报告格式
  4. 04文档命名和标题规范
  5. 05状态跟踪与交叉引用

适用场景

  1. 01在实现前规划功能
  2. 02记录技术设计和测试计划
  3. 03对照设计检查实现情况
  4. 04记录 Sprint 进度与完成情况

安装

复制下面的命令，在终端中运行。

$npx skills add https://github.com/ww-w-ai/bkit-claude-code --skill bkit-templates

安装后在 Claude Code 中输入/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.mdCLAUDE.md 模板
Sprint（多功能容器，8 个阶段，v2.1.13）
模板路径用途
主计划${CLAUDE_PLUGIN_ROOT}/templates/sprint/master-plan.template.mdSprint 范围 + 功能 + 依赖关系图 + Trust 范围
PRD${CLAUDE_PLUGIN_ROOT}/templates/sprint/prd.template.mdSprint 级产品需求
计划${CLAUDE_PLUGIN_ROOT}/templates/sprint/plan.template.mdSprint 计划（综合各功能计划）
设计${CLAUDE_PLUGIN_ROOT}/templates/sprint/design.template.mdSprint 级技术设计
迭代${CLAUDE_PLUGIN_ROOT}/templates/sprint/iterate.template.md迭代日志 + iterateHistory
QA${CLAUDE_PLUGIN_ROOT}/templates/sprint/qa.template.md7 层 dataFlowIntegrity（S1）报告
报告${CLAUDE_PLUGIN_ROOT}/templates/sprint/report.template.mdSprint 完成情况 + 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 行为
✅ 已批准用作参考按原样遵循
🔄 进行中正在编写通知变更
⏸️ 暂停暂时搁置请求确认
❌ 已弃用不再有效忽略
冲突解决
  • 代码与设计不匹配：以代码为准，建议更新文档
  • 存在多个版本：仅参考最新版本

评论

支持 Markdown