关于 business-knowledge-workflow
业务知识工作流 Skill 用于理解陌生业务模块、核验文档与代码,并将结论沉淀为可复用的知识资产。它强调先获取背景,再通过代码或运行链路验证,最后整理模块边界、主链路和常见问题。
主要功能
- 01发现并筛选业务文档
- 02通过代码交叉验证文档描述
- 03将结论整理为 Skill 或架构文档
- 04聚焦模块边界、关键对象和主链路
- 05提供常见陷阱与后续阅读指引
适用场景
- 01快速了解陌生业务模块
- 02结合代码验证 iWiki 或其他文档
- 03为后续开发排障整理模块说明
- 04把调研结果沉淀为可复用 Skill
安装
复制下面的命令,在终端中运行。
$
npx skills add https:/ / github.com/ tencentblueking/ bk-ci --skill business-knowledge-workflow安装后在 Claude Code 中输入/business-knowledge-workflow确认已加载。
包含的文件
除 SKILL.md 外,安装时一起下载的参考资料和脚本。
reference/1-document-discovery.md2-code-cross-check.md3-skill-distillation.md详细介绍
来自项目 README业务知识工作流
适用场景
- 需要快速理解一个陌生业务模块
- 需要从 iWiki 或其他文档系统获取背景知识
- 需要把文档描述和实际代码做交叉验证
- 需要把知识沉淀成 skill、架构文档或模块说明
不适用场景
- 已经明确知道该修改哪段代码,只是去实现
- 只是压缩已有 skill,不需要重新获取业务知识
- 只是补普通说明,不需要形成复用知识资产
快速指导
- 这个 skill 关注的是“先理解,再验证,最后沉淀”,不是直接改代码。
- 业务知识获取通常分三段:
- 文档发现与初筛:
reference/1-document-discovery.md - 代码交叉验证:
reference/2-code-cross-check.md - 沉淀为 skill / 架构文档:
reference/3-skill-distillation.md
- 文档发现与初筛:
- 文档内容默认不可信到可以直接复述,必须经过代码或运行链路验证。
- 沉淀时优先写模块边界、关键对象、主链路和常见坑,而不是复制百科说明。
- 如果最后产物是 skill,再联动看
skill-writer。
高信号规则
- 业务文档和代码实现经常不完全一致
- 好的业务知识文档应该能回答“这模块解决什么问题、主链路是什么、改动时先看哪里”
- 沉淀结果要优先服务后续开发和排障,而不是保留原始资料堆积
关键陷阱
- 只读文档,不做代码核验
- 把外部资料原样搬运进 skill
- 输出结构没有边界感,导致后续继续膨胀
延伸阅读
- 文档发现与初筛:
reference/1-document-discovery.md - 代码交叉验证:
reference/2-code-cross-check.md - 沉淀为 skill / 架构文档:
reference/3-skill-distillation.md - 如果你要写 skill:再看
skill-writer
评论
支持 Markdown