neat

🧹 智能知识库洁癖管家

跨平台 Agent 会话结束时的知识库编辑技能,通过"毕业机制"将记忆与代码/docs双向核对,防止知识腐烂膨胀,确保项目文档始终保持干净、准确、新人友好。

收藏
1.2k
安装
354
版本
1.2.0
CLS 安全扫描中
预计需要 3 分钟...

使用说明

核心用法

洁癖(neat-freak) 是一款面向 Claude Code、OpenAI Codex、OpenCode、OpenClaw 等跨平台 Agent 的会话末期知识库整理技能。它并非通用的"整理"工具,而是专门在开发里程碑结束时触发——当用户说"sync up"、"tidy up docs"、"/neat"或"整理文档"时,执行一次系统性的知识库核对与收敛。

技能的核心模型建立在三层知识架构之上:①Agent 记忆(运行时积累)、②项目根目录的 CLAUDE.md/AGENTS.md(Agent 规则手册)、③项目 docs/ 与 README.md(面向其他开发者)。三层受众不同、职责不重叠,技能强制执行"毕业机制"(promote)——将稳定的记忆知识向上泵入文档层,防止记忆文件无限膨胀。

执行流程严格遵循六步协议:第零步尺寸体检(运行 kb_audit.mjs 闸门脚本)、第一步盘点现状(机械式枚举所有文件)、第二步识别变更(使用变更影响矩阵)、第三步实际修改(docs → CLAUDE.md → 记忆的顺序,减优于加、删除优于保留)、第四步自检清单(重跑闸门验证)、第五步变更摘要(三段式输出)。

显著优点

防腐烂架构设计:通过"毕业机制"解决 Agent 记忆"只追加不收敛"的先天缺陷,配合尺寸闸门(HARD/SOFT 分级)和相对时间豁免规则,形成知识生命周期的闭环管理。

跨平台通用性:单一 SKILL.md 同时适配 Claude Code、Codex、OpenCode 等多款 Agent,遵循开放 Agent Skill 规范,降低团队多工具切换的认知成本。

精细化控制:破坏性操作(删除记忆、重写文档)前强制读取 controls.md 护栏规则,要求 git 工作树、支持 dry-run 预览,最小化误操作风险。

模块化按需加载:重内容拆入 rules/ 目录,执行时只加载当前步骤所需的判据文档,避免一次性加载冗长规范导致的上下文污染。

潜在缺点与局限性

触发精度敏感:明确排除了裸"整理"、代码整理、临时文本格式化、孤立记忆维护等场景,误触发会导致与其他 skill 撞车。用户需要准确理解"刚改完代码、现在要让文档和记忆跟上"这一核心意图。

依赖外部审计脚本:第零步和第四步强依赖 scripts/kb_audit.mjs,若项目未配置该脚本或 Node 环境异常,整个同步流程会被阻断。

学习曲线陡峭:三层知识模型、毕业判据、变更影响矩阵、尺寸闸门等概念需要一定时间内化,小型项目可能感到"过度设计"。

仅面向开发场景:明确 NOT for 非开发"整理",适用范围相对狭窄。

适合的目标群体

  • 长期迭代的中大型项目团队:代码与文档频繁不同步,新成员 onboarding 困难
  • 多 Agent 混合使用的开发者:需要在 Claude Code 与 Codex 之间保持知识一致性
  • 追求工程规范的 Tech Lead:希望建立可复现的知识管理流程,而非依赖个人习惯
  • 文档驱动开发的实践者:将 CLAUDE.md 作为 Agent 协作契约的项目

使用风险

数据丢失风险:第三步会执行删除和重写操作,虽有 git 护栏和 HARD/SOFT 分级阻断,但误配置 controls.md 或忽略 dry-run 仍可能导致记忆或文档丢失。

性能与依赖风险kb_audit.mjs 脚本在大型知识库上可能耗时较长;Node.js 版本差异、路径解析差异(Windows/macOS/Linux)可能导致跨平台行为不一致。

流程阻断风险:HARD 违规(尺寸超限、倒挂等)会阻断本次"同步完成",团队需预留时间处理超尺寸修复,否则可能积压多轮未同步的变更。

过度收敛风险:"减优于加"的编辑原则若执行过激,可能误删仍有价值的上下文,特别是跨项目依赖的隐性知识。

neat 内容

references文件夹
rules文件夹
scripts文件夹
手动下载zip · 42.7 kB
agent-paths.mdtext/markdown
请选择文件