关于 claude-md-updater
claude-md-updater 用于从对话中识别值得长期保存的项目事实,并生成指令文件修改提案。它先展示精确 diff 供批准,获批前不会写入文件。
主要功能
- 01识别持久的项目知识
- 02定位 AGENTS.md 或 CLAUDE.md
- 03生成精确统一 diff
- 04等待批准后再写入
- 05避免保存敏感值和临时记录
适用场景
- 01记录排错中发现的长期经验
- 02更新基础设施和端点信息
- 03保存可重复使用的工作流程
安装
复制下面的命令,在终端中运行。
$
npx skills add https:/ / github.com/ jamditis/ claude-skills-journalism --skill claude-md-updater安装后在 Claude Code 中输入/claude-md-updater确认已加载。
附带文件agents/openai.yaml
详细介绍
项目指令更新器
分析当前对话,找出值得保存在项目指令文件中的信息,然后先提出编辑方案供用户批准,再进行任何写入。
起草前确定目标文件:
- 如果存在
AGENTS.md,则更新它。在 Claude Code 中,如果不存在CLAUDE.md,还要提议添加一行CLAUDE.md导入语句@AGENTS.md。Claude Code 加载的是CLAUDE.md,而不是AGENTS.md。 - 如果只有
CLAUDE.md,则更新它。 - 如果两个文件都存在,且其中一个导入了另一个,则更新被导入的规范文件。
- 如果两个文件都不存在,则创建
AGENTS.md。在 Claude Code 中,还要提议添加一行CLAUDE.md导入语句。
查找内容
1. 来之不易的经验
- 揭示了非显而易见原因的调试过程
- 针对平台或工具限制的变通方案
- 从失败中发现的反模式
- “真正的问题是……”这类发现
2. 新基础设施
- 新部署的服务
- 新端点或 URL
- 新文件路径或目录
- 新凭据或令牌(仅引用其存放位置,绝不包含实际值)
3. 新工作流
- 能解决反复出现问题的命令
- 行之有效的多步骤流程
- 系统间的集成模式
4. 更新的信息
- 变更后的端口、IP 或 URL
- 现有系统新增的功能
- 已弃用或移除的功能
分析流程
-
扫描对话,查找关键词:
- “已修复”“已解决”“问题在于”“原来是”
- “已部署”“已设置”“已配置”“已安装”
- “新端点”“新服务”“新路径”
- “不起作用”“限制”“变通方案”
-
对发现进行分类。 只有持久性事实才应写入项目指令文件:
- 将来之不易的经验放入“来之不易的经验”部分
- 将基础设施变更更新到相关部分
- 将新工作流放入适当部分
- 临时的、仅适用于当前会话的备注不要写入项目指令文件(参见“不要保存的内容”)
-
生成精确差异。 针对已确定的指令文件生成统一差异,展示要添加或更改的具体行和部分。用户批准的是这份差异,而不是摘要。
-
先展示差异供用户批准,获得批准前不要写入任何内容。
输出格式
先展示精确补丁,然后按类别提供简短摘要:
## Proposed project instruction updates
```diff
--- a/AGENTS.md
+++ b/AGENTS.md
@@ section being changed @@
existing context line
+new durable lesson, infra fact, or workflow
```
Summary of the diff above:
- Hard-won lessons: [one line, if any]
- Infrastructure updates: [one line, if any]
- New workflows: [one line, if any]
Apply this diff? Nothing is written until you approve.
不要保存的内容
项目指令文件由团队共享、提交到 git,并会加载到 Agent 会话中。应将其用于记录持久且很少变更的事实,而不是作为流水日志。根据项目记忆技能,以下内容不应写入:
- 临时的“今天做了什么”会话摘要
- 频繁变更的内容
- 客户通过长期纠正逐渐掌握的内容
将这些内容保存到客户端的记忆功能中(在 Claude Code 中,使用 ~/.claude/projects/<project>/memory/ 下的自动记忆),或保存到已加入 git 忽略列表的本地备注文件中(在 Claude Code 中,使用 CLAUDE.local.md)。将这些内容写入共享项目指令会使上下文臃肿,并导致过时的会话信息在后续会话中加载。
规则
- 绝不添加敏感值。 只引用凭据的存放位置,绝不包含实际令牌。
- 保持简洁。 项目指令文件应便于快速浏览;目标是不超过 200 行。
- 避免重复。 添加信息前,先检查其是否已存在。
- 遵循现有风格。 与当前文件的语气和格式保持一致。
- 只记录持久事实。 保存来之不易的经验、基础设施事实和工作流。仅适用于当前会话的备注应放入客户端记忆或已加入 git 忽略列表的本地备注文件中,绝不可写入已提交的项目指令文件。
评论
支持 Markdown