SuperAPI AI 工具集

docs-audit

办公与效率

查看项目

更新于 10-15 20:14

技能介绍

用途:审计当前分支或 PR 的改动,找出用户需要阅读但文档站未覆盖的内容,并在 hivedesktop.com 对应页面补充或更新。文档站覆盖 Desktop 与 CLI 两个产品,分别位于 docs/docs/desktop/ 与 docs/docs/cli/。

主要能力:先用 git diff main...HEAD --stat 及针对 cmd/desktop/internal/app、cmd/desktop/frontend/src、cmd/hive、internal/config 的 diff 界定范围;未检出的 PR 用 gh pr diff <number>。随后盘点用户可见项:设置项、节点或动作类型、界面区域、快捷键或命令、面向智能体的内容、CLI/TUI 改动、用户会遇到的失败。纯重构、测试、内部重命名或绘制方式改动不产生文档项,审计无发现也是有效结果。

使用方式:按主题归属表决定写到哪里,例如设置写入 docs/docs/desktop/configuration/settings.md,快捷键写入 keybindings.md,CLI 配置写入 docs/docs/cli/configuration/index.md。新页面较少见,需加入 docs/zensical.toml 的导航,否则仅能通过 URL 访问。写作遵循最小有用页面、事实单一归属、先写前置条件、使用相对 Markdown 链接等约定。完成后运行 mise run docs:build(新工作树先运行 mise run docs:install),该命令以 --strict 构建并在警告时中止。

适用场景:Hive 仓库中涉及用户可见行为的改动审计,包括 Desktop 与 CLI 文档、发布说明片段、随附技能与 Claude 插件技能同步。

限制:无法在代码中验证的事实不得写入页面;构建无法发现未加入导航的页面,也无法判断默认值是否正确,需人工复核。资料未提供该技能的安装方式、收费或平台信息。