发布前的最后一道防线:Step09检品检查清单技能使用心得
做开发这么多年,最怕的就是发布前手忙脚乱地检查各种东西。以前我们团队每次发版前都要人工核对一堆文档和代码,漏掉一两个点都是常有的事。后来我发现了这个Step09检品检查清单技能,简直就像给发布流程加了一道自动化的保险丝,今天就来好好聊聊这个工具。
这个技能到底是干嘛的?
简单说,它就是帮你自动生成一份发布前的“检品检查清单”。啥叫检品?就是像工厂里质检员检查产品一样,把你要发布的软件从头到脚检查一遍。这个技能会读取你们项目里的所有关键文档——技术规格书、业务规格书、设计文档、测试结果,还有代码差异(就是git diff develop..HEAD),然后从六个维度生成一份超级详细的检查清单。
这六个维度分别是:
- 规格 vs 实现一致性:检查所有需求是不是都实现了,有没有夹带私货(不在规格里的改动),边界情况(0条数据、大量数据、NULL值)处理得咋样。
- 性能验证:有没有设置响应时间、查询次数、内存使用的目标值?N+1问题解决了没?索引建得合理吗?
- 后向兼容性:有没有破坏现有API?老页面会不会崩?批量处理受影响不?
- 安全性:SQL注入、XSS、认证授权、敏感数据,这些老生常谈但又常翻车的地方。
- UI/UX:界面会不会错位?操作顺手吗?报错信息说人话不?
- 既有bug修正确认:修复的bug真的修好了吗?有没有引入新的问题?
怎么装?简单三步走
装这个技能特别简单,因为它是个标准的Claude Skill。在终端里敲一行命令就搞定:
npx skills add https://github.com/bravesoft-inc/waterfall-agents --skill step09-inspection
装完之后,你在Claude或者任何支持Skills的AI助手里,直接说“检品检查清单”或者输入“/step09-inspection 功能名”(比如 project-list-n-plus-one-fix),它就开始干活了。
实际用起来是个啥体验?
我第一次用的时候其实有点忐忑,怕它生成的东西太模板化。结果它先自己读取了docs/02_active/那个功能目录下的所有文档,还调了git diff,然后就生成了一份带ID、区分、检品观点、确认方法、判定(留空给你填)的清单。每个大项下面还有小条目,比如性能这块会具体到“N+1查询是否已消除”,真的挺细的。
最让我喜欢的一点是,它会去看docs/knowledge/目录下的历史问题记录。就是你们团队以前踩过的坑,它会自动加进新的检查清单里。这个功能太实用了,等于团队的经验教训能自动传承下去,不用每次发版前都翻旧账。
生成之后怎么处理?
生成完的清单文件会放在 docs/02_active/你的功能名/09-inspection-checklist.md 这个位置。它还会帮你自动git add和git commit,提交信息都写好了:“docs: add inspection checklist for 功能名”。是不是很省心?你只需要拿着这个清单,让开发同事逐项确认打勾就行。
不过这里有个小提醒:清单生成后,判定那一栏是空的,需要人工去确认每一项。毕竟机器只能帮你列问题,最终拍板还是要靠人。而且它只是生成了清单,真正的检品执行(下一步)是另外的技能负责的,比如下一个步骤是“/step09-run”,所以这个技能更像是发布前的“准备环节”。
适用场景和注意事项
这个技能明显是为瀑布流开发流程设计的,因为它依赖的文档结构(docs/02_active/下的规格书、设计书、测试用例)就是那种严格分阶段的流程。如果你用的是敏捷开发,可能得先调整文档结构才能用。
另外,它需要能访问到项目的git仓库,因为要读git diff。而且得确保你的环境里装了git和node/npx(用npx命令安装时需要)。
如果你是做外包项目或者给大客户做交付,这种检品清单特别有用。因为客户那边可能也要求你提供类似的检查报告,用这个技能自动生成,再人工补充确认,效率高多了,而且显得专业。
一点小吐槽和技巧
说实话,这个技能的文档写得挺简洁的,但正因为简洁,刚开始用可能会有点懵。我建议你第一次用的时候,先手动跑一遍,看看它生成的清单长什么样,然后再去调整输入文件。另外,记得确保docs/knowledge/目录下有内容,不然它没法从历史问题中学习。
还有个小技巧:如果你不想让它在生成后自动commit,可以在调用前临时改一下git配置,或者生成后马上amend。不过我觉得让它自动commit挺方便的,反正提交信息写得很清楚。
总之,如果你也在为发布前的质量检查发愁,不妨试试这个技能。虽然它不能完全替代人工检品,但能帮你把该检查的点全部列出来,一个不漏。而且有了这份清单,和开发、测试沟通起来也更有底气,毕竟白纸黑字写着呢!
好了,今天就分享到这里,希望对你有帮助。下次再聊聊怎么用它的下一步技能来真正执行检品吧~