代码规范挖掘
将以下提示词粘贴到你的 AI 对话框中:
请根据 https://skillhub.cn/install/skillhub.md,安装 @kunlungrowth/kg-spec-miner。
技能介绍
问题:当代码没有说明书
接手一个跑了几年的系统,常见困境不是写不出新代码,而是说不清老代码在做什么。入口藏在一堆路由和初始化调用里,核心模块依赖关系散在配置、中间件和匿名函数之间,业务规则只存在于几个 if 分支和校验函数里,却没有任何文档能告诉你哪些是刻意约束,哪些是历史遗留。此时直接改代码很容易误伤,重构也不敢下手。
核心能力与工作流
该技能把这件事拆成可重复的逆向流程,核心是抽取规格、依赖、API 与业务规则,而不是生成营销式摘要。
- 界定范围:先明确分析整系统还是某特性,避免无边界探索。
- 探索定位:用文件结构与关键字找入口、核心模块和关键符号。
- 依赖追踪:沿数据流或请求路径画调用链与依赖关系。
- EARS 文档化:用 EARS 格式记录观察到的行为,保留代码中的实现事实。
- 输出工件:返回
SpecExtract,包含scope、requirements、deps、open、notes等字段,供feature-forge转需求或code-documenter出文档。
适用边界
它适合理解遗留/无文档系统、生成现有代码文档、抽取实现中的需求与边界。但它不做凭空猜测:业务意图不清楚时会标注为待确认项,不会把假设写成需求。输出中的 open 字段专门用来承载需要人工确认的问题。
使用场景
- 接手无文档老系统,理清模块入口与调用链,补齐基础说明。
- 从现有代码中抽取业务规则与边界条件,整理成需求列表。
- 新成员入职时,用静态分析生成现有系统的 API 与依赖说明。
- 改动前做影响面分析,沿请求路径列出相关模块与潜在风险。
适合人员
- 接手老项目的后端工程师,想在动手改之前先弄清模块职责和依赖关系。
- 负责迁移或重构的技术负责人,需要从代码中还原需求与边界条件。
- 为遗留系统补文档的架构师,希望产出结构化规格而不是逐行注释。
- 参与需求评审的测试工程师,要从实现里反推边界情况和待确认项。