入职新项目最怕文档对不上代码?腾讯蓝瀛这个Skill帮你搞定
入职新项目,最怕的是什么?加班?需求变更?不,是给你一堆文档,结果文档和代码完全对不上。
我之前带团队,接手一个陌生业务模块,文档写的是A功能在第3步跳转页面,结果代码里压根没有第3步——文档是半年前写的,代码早就重构了。这种”幽灵文档”简直是团队效率杀手。
最近挖到一个腾讯蓝鲸的开源 Skill,叫 business-knowledge-workflow,专门解决”文档与代码不一致”这个顽疾。
它怎么工作的?
三步走:
第一步:文档发现与初筛
先从 iWiki、Confluence 或者任何文档系统里,把和目标模块相关的资料都捞出来,做一轮初筛。筛掉明显过时、重复、或者和主线无关的内容。
第二步:代码交叉验证 ⚠️ 关键环节
文档内容默认不可信,必须拿代码实际走一遍主链路。Skill 里有标准的代码交叉核验流程——对每一个文档描述的流程点,在代码里找到对应的实现,验证逻辑是否吻合。
第三步:沉淀为 Skill / 架构文档
验证通过的知识,才允许沉淀成可复用的资产。这里优先写的是模块边界、关键对象、主链路和常见坑——不是复制粘贴原始文档,而是经过消化的结构化输出。
适合谁用?
- 刚入职需要快速理解陌生业务模块的开发同学
- 负责文档维护、想把散落的业务知识结构化的同学
- 想把经验沉淀成可复用 Skill 资产的团队
不适合谁?
已经知道改哪段代码、只是去实现这种任务,不需要这个 workflow;另外纯压缩现有 Skill 也不适用。
核心设计哲学
这个 Skill 有一句话我特别喜欢:“业务文档和代码实现经常不完全一致,文档内容默认不可信到不可以直接复述。”
说白了就是:文档只是线索,代码才是真相。
这个思路,其实适合所有需要维护复杂业务系统的团队——不一定非要用腾讯蓝鲸的工具,但这种”文档→验证→沉淀”的workflow思维值得抄。
GitHub 仓库是 TencentBlueKing/bk-ci,Star 数 2.5k,属于腾讯蓝鲸 CI 的 AI Skills 系列,感兴趣的同学可以去看看具体实现。
👉 https://github.com/TencentBlueKing/bk-ci/tree/master/ai/skills/business-knowledge-workflow
GitHub: https://github.com/TencentBlueKing/bk-ci/tree/master/ai/skills/business-knowledge-workflow
评论区
登录后可评论。