mcpField
K
knowledge-consolidation

knowledge-consolidation

github.com/learnwy生产力565 次安装21 周前更新
代码仓库

关于 knowledge-consolidation

用于在 IDE 对应的项目目录中记录调试、配置、工作流和经验的知识整理技能,以结构化 Markdown 文件保存。CLI 创建只写一次的笔记,可将通用内容转入 llm-wiki;Stop 钩子会在解决复杂问题后提示保存。

主要功能

  1. 01创建项目内结构化 Markdown 笔记
  2. 02按类型分类笔记
  3. 03解析唯一路径并校验字段
  4. 04将通用笔记转入 llm-wiki
  5. 05在复杂问题解决后发出提示

适用场景

  1. 01记录特定代码库的故障修复
  2. 02记录构建或配置决策
  3. 03保存部署或回滚流程
  4. 04将可复用笔记转入 llm-wiki

安装

复制下面的命令,在终端中运行。

$npx skills add https://github.com/learnwy/skills --skill knowledge-consolidation

安装后在 Claude Code 中输入/knowledge-consolidation确认已加载。

包含的文件

除 SKILL.md 外,安装时一起下载的参考资料和脚本。

hooks.json
assets/
knowledge.md.template
examples/
debug-session.md
references/
conditional-reflection.md
knowledge-types.md
scripts/
cli.cjs
scripts/hooks/
post-resolution-nudge.cjs

详细介绍

知识沉淀

项目本地修复日志。一次对话 → 在此仓库的 IDE 文件夹中创建一个结构化 Markdown 文件。与代码库放在一起;随仓库一同发布;后续处理此项目的会话都能找到它。

边界: 项目本地的调试、配置、工作流和经验记录归于此处。 全局、可复用的知识(架构、设计模式、API 集成、参考资料)归于 llm-wiki。当某篇文档值得收入 wiki 时,KC 的 promote 命令会将其移至两者之间的界线另一侧。

何时使用

触发条件操作
用户说“保存这个”“记录下来”“我们解决了”运行 cli.cjs save …
触发停止提醒(“看起来你解决了一个不简单的问题”)提议保存
解决了特定于此代码库的 bug--type debug
确定了不明显的配置或构建设置--type config
制定了运维流程(部署/回滚)--type workflow
事后分析/回顾总结--type lesson

不要用于: 跨项目知识(→ llm-wiki)、可复用技能(→ project-skill-writer)、AI 规则(→ project-rules-writer)、更新先前保存的文档(KC 采用一次写入方式)。

前提条件

  • Node.js ≥ 18
  • 项目根目录包含一个 IDE 标记目录:.trae/、.claude/、.cursor/ 或 .windsurf/

通常需要使用的命令

node scripts/cli.cjs save \
  -r <project_root> \
  -a <ai_type> \
  -t <type> \
  -n <kebab-slug> \
  --title "Short, specific title" \
  --summary "2-3 sentences readers can stop at" \
  --details "Body in Markdown." \
  --takeaways "First actionable insight\nSecond insight" \
  [--background "<one-line problem context>"] \
  [--context "<project / version / component>"] \
  [--related "<links / files>"]

返回新文件的绝对路径。以原子方式生成按日期排序的名称、创建目录、填充模板并验证必填字段。

-a, --ai-typetrae、trae-cn、claude-code(或 claude)、cursor、windsurf
-t, --type仅限 debug、config、workflow、lesson — 参见 knowledge-types.md
-n, --namekebab-case 格式的名称,≤50 个字符,且需具体(react-18-hydration-mismatch,而非 bug-fix)

输出文件名:{YYYYMMDD}_{NNN}_{type}_{slug}.md,位于 <root>/<ide>/knowledges/ 下。

提升至全局 wiki

当某篇文档可在多个项目中复用时,将其加入 llm-wiki 的待处理队列:

node scripts/cli.cjs promote -p <project>/.trae/knowledges/20260511_001_debug_x.md

复制到 ~/.learnwy/llm-wiki/raw/notes/<date>-<slug>.md,并添加指向原文的 frontmatter 引用。若 wiki 尚未初始化,则不执行任何操作。接下来运行 llm-wiki 的导入流程。

其他命令

node scripts/cli.cjs path -r <root> -a <ai> -t <type> -n <name>
# → just prints the resolved path; useful for scripts that want to write the file themselves.

停止钩子(自动提醒)

一个 Stop 钩子会扫描助手的上一条回复,查找问题已解决的信号(“问题是……” “修好了” “## Solution”)。若检测到此类信号,且回复中包含实质性标记(竞态条件、回归、设计决策、“微妙”等),同时没有会话内琐碎问题标记(拼写错误、缺少分号、环境变量错误),则会在每个会话中注入一次提醒:“考虑运行 knowledge-consolidation save”。

此钩子不会自动写入内容,只会提醒;由 AI 询问用户。

此钩子通过 learnwy-dispatch 接入(单个 Node 进程,不会为每项技能单独启动进程)。

写作质量规则

  1. 标题应回答“我能从中学到什么?”——不要写“调试会话”,而要写“WebSocket 重连处理程序中的内存泄漏”。
  2. 摘要应完整自足——读者据此决定是否继续阅读。
  3. 详情中的代码块应标注语言;较长内容应使用小标题。
  4. 要点应采用祈使句——写“先检查 X,再检查 Y”,而非“X 很重要”。
  5. 相关内容应在适用时链接源文件、PR 或 [[wiki-page]] 引用。

边界

此技能仅:

  • 检测 IDE 标记并解析唯一知识文档路径
  • 根据 CLI 参数以原子方式写入结构化文档
  • 将文档提升至全局 llm-wiki 待处理队列
  • 在解决不简单的问题时,每个会话仅提示一次

此技能不会:

  • 更新现有文档(有意采用一次写入方式)
  • 编制索引/检查/整理内容(这些属于 llm-wiki)
  • 跨会话保存 AI 记忆
  • 搜索以往的知识文档

评论

支持 Markdown