工程需求知识沉淀
将以下提示词粘贴到你的 AI 对话框中:
请根据 https://skillhub.cn/install/skillhub.md,安装 @user_35ebe43a/knowledge-manager。
技能介绍
要解决什么问题
中大型工程里,设计决策和踩坑记录往往散落在 PR 评论、临时笔记和开发者脑子里。功能迭代后,新人翻 knowledge/ 要么缺页、要么和代码对不上;方案下线后直接被删,排查历史 bug 只能硬啃 git history。
技能如何工作
本技能围绕仓库内 knowledge/ 目录,把「会话里发生了什么变更」转成可维护的文档,并维护索引闭环。
知识更新流程大致是:
- 初始化:若不存在
knowledge/README.md,先走references/initialization.md - 抽取变更:从当前会话提取新增/修改功能、核心文件、关键设计决策
- 检索已有文档:用 code-explorer subAgent 搜
knowledge/,避免整库文档灌进主上下文 - 判断是否沉淀:复杂业务逻辑、重要设计决策、易踩坑点 需要;简单 bug 修复、纯重构、临时调试 不需要
- 先确认再写:列出拟更新/新增的文档及理由,征得确认后再执行
- 写作规范:写前读
references/writing-guidelines.md;前后端分离且涉及后台字段/接口时,再读references/frontend-backend-collection.md - 索引闭环:新增或改文档后 必须 同步
knowledge/README.md里的知识索引表
知识归档流程与更新并列、独立触发:文档不再代表当前事实时,移到同主题域下 archive/,顶部加过时声明,并从主索引移到「已过时文档(Archive)」表——不直接删除,保留历史可追溯性。
目录约定:文件名与目录名用 kebab-case;组件/功能在 knowledge/[模块名]/,架构在 knowledge/architecture/,指南在 knowledge/guides/。
适用边界
优先 增量更新 已有文档,大范围改动前先确认;无新知无需沉淀时不必强行输出提示。
使用场景
- 一次会话里改了权限校验和回调逻辑,需要对照 knowledge/ 判断是改旧文档还是新开一篇
- 方案从旧 token 刷新改成统一网关刷新,要把旧设计文档移入 archive 并更新 README 索引
- 前后端分离改动涉及新接口字段,要按前后端采集模板沉淀后台行为再维护索引
- 新同学接手模块前,要从当前会话整理涉及的核心文件和设计决策清单供确认后写入
适合人员
- 维护 monorepo 或长期迭代业务的后端,希望 PR 里的设计理由能进 knowledge/ 而不是只留在评论里
- 带前后端分离项目的全栈,需要把接口字段与后台行为按模板写进知识库并跟 README 索引一致
- 技术负责人或架构师,在方案替换或能力下线时要走归档流程而不是删文档
- 用 AI 结对编程的工程师,想在会话结束自动筛出「值得沉淀」的复杂逻辑再增量改文档