技能文档同步

写作 社区

技能解读

当前原文的自动摘译,尚未人工审校。

帽子

扫描最多 30 个文档文件 — 跳过超出上限的文件,警告用户 切勿破坏更改日志 — 仅追加,绝不删除现有条目 在更改叙述/哲学部分之前询问用户 — 有风险的更改需要确认

第 3 步:自动更新事实更正

自动修复路径、计数、表条目和版本号。这些是机械变化,不会改变意义。自动更新目标:在 diff 中重命名或移动的文件路径 数字计数(例如,数字更改时为“42 次测试”) 版本字符串(例如,当 package.json 碰撞时为 v9.5.0)

流狐档案 运行与权限由流狐静态检查推断,不代表作者声明或实际测试结果。
领域
写作
作者声明的智能体
未找到明确声明;不据此推断已兼容或已测试
静态检查
88 / 100 · 启发式扫描,不代表运行安全
运行环境证据
未执行;当前没有隔离运行测试证据
作者 / 版本 / 许可证
@nyldn · 未声明许可证
上下文用量评级
低消耗
接入复杂程度
需手动接入
是否需要外部接口密钥
不需要
兼容的系统
Docker
运行环境要求
Docker
检测到的文件与系统行为
  • 只读
  • 允许写入 / 修改
  • 命令执行
网络行为
仅限本地
安装命令数
无(仅作为资料)

需要注意: 未声明工具权限范围;实际权限由运行环境决定。

01
第 1 步:发现文档

查找项目根目录中的所有`.md`文件(最大深度2),跳过`node_modules/`和`.git/`。阅读每个发现的文档文件,以便了解其当前内容的上下文。

02
第 2 步:交叉引用差异

运行`git diff --stat HEAD~1`(如果在功能分支上,则与基础分支进行比较)以识别哪些文件已更改以及每个文档中哪些内容现在可能已过时。对于每个文档文件,检查文档中提到的任何路径、函数名称、计数或版本号是否受到差异的影响。

03
第 3 步:自动更新事实更正

自动修复路径、计数、表条目和版本号。这些是机械变化,不会改变意义。自动更新目标:在 diff 中重命名或移动的文件路径 数字计数(例如,数字更改时为“42 个测试”) 版本字符串(例如,当 `package.json` 碰撞时为 `v9.5.0`)

04
步骤 4:风险变更检测

标记叙述、哲学或安全相关的文档部分以供用户确认。不要自动编辑这些。风险类别(需要用户批准): 标题包含以下内容的部分:“理念”、“原则”、“愿景”、“使命”、“安全”、“威胁模型”、“架构决策” 表达观点、策略或基本原理(不仅仅是事实)的段落 `## Why` 或 `## Rationale` 标题下的内容

05
第 5 步:CHANGELOG 语音润色

将“销售测试”应用于每个变更日志条目:“阅读此项目符号的用户会认为‘哦,太好了,我想尝试一下’?”规则: 以用户利益为主导,而不是实施细节 使用主动语态(“添加 X”而不是“添加了 X”) 将项目符号控制在 120 个字符以内

06
第 6 步:跨文档一致性

检查所有文档文件中的键值是否一致。一致性检查: 版本号与 `README.md`、`CLAUDE.md`、`package.json`、`CHANGELOG.md` 以及引用当前版本的任何其他文件相匹配 自述文件中的功能列表与实际实现的内容相匹配(与命令/技能目录交叉引用) 徽章 URL 和shield.io 引用是最新的

07
第 7 步:可发现性检查

确保每个文档文件都可以从`README.md`或`CLAUDE.md`访问。孤立文档是不可见的文档。检查:项目中的每个`.md`文件都应从`README.md`或`CLAUDE.md`链接(直接或通过另一个链接文档传递)标记没有入站链接的孤立文档建议在何处添加孤立文档的链接

08
第8步:TODOS.md更新

根据差异更新项目的任务跟踪。操作: 标记已完成的项目:扫描差异中删除的 TODO/FIXME/HACK 注释,并将相应的项目标记为已完成 标记新的推迟工作:扫描差异中添加的 TODO/FIXME/HACK 注释并创建新的跟踪条目 如果项目使用进度跟踪,则更新完成百分比

讨论

基于 GitHub Discussions。登录 GitHub 即可参与讨论、点赞、订阅更新。