mcpField
D
doc-sync

doc-sync

github.com/chmouel测试与质量31343 次安装今天更新
代码仓库

关于 doc-sync

doc-sync 是用于检查 lazyworktree 文档一致性的 Skill。它对比 README、man 页面和应用内帮助中的按键绑定与说明,并报告差异及文件路径、行号。

主要功能

  1. 01对比三个文档来源
  2. 02查找缺失的按键绑定
  3. 03检查描述不一致
  4. 04标记过时信息和拼写问题
  5. 05报告文件路径和行号

适用场景

  1. 01发布前检查按键绑定是否一致
  2. 02查找帮助文本与文档间的差异

安装

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

$npx skills add https://github.com/chmouel/lazyworktree --skill doc-sync

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

详细介绍

文档同步检查

比较文档源,检查按键绑定和功能文档是否一致。

说明

  1. 阅读 README 按键绑定部分:使用 Read 工具读取 README.md,然后找到 ## Key 部分(按键绑定表)

  2. 阅读 man 手册页按键绑定:使用 Read 工具读取 lazyworktree.1,然后找到 KEYBINDINGS 部分

  3. 阅读帮助屏幕文本:使用 Read 工具读取 internal/app/screen/help.go,然后找到包含应用内帮助内容的 helpText 变量

所需分析

比较这三个来源,并指出:

  1. 任一来源中缺失的按键绑定
  2. 各来源之间不一致的描述
  3. 过时或不正确的信息
  4. 英式拼写违规项
  5. 使所有来源保持同步的具体建议

对发现的任何差异,报告文件路径和行号。

评论

支持 Markdown