SuperAPI AI 工具集

oma-docs

写作与研究

查看项目

更新于 10-16 05:47

技能介绍

用途:让仓库文档与代码行为保持一致,并报告验证的局限。适用于仓库文档校验、基于 diff 的同步和翻译维护。不适用于通用源码检索(用 oma-search)、功能实现(交给对应专家)或已知文本翻译(用 oma-translation)。

主要能力:verify 提取并解析文档引用后汇总报告;sync 获取候选、读取相关文档与 diff,仅应用已授权的修正;i18n 与 lint 报告翻译漂移或风格问题,授权修正交由 oma-translation。仅审查的请求只产出建议;已有明确范围的编辑请求即视为授权直接应用修正。

使用方式:输入模式(verify、sync、i18n、lint)、目标路径或 diff 范围及授权编辑范围;未指定模式时默认 verify。常用命令:oma docs verify --json、oma docs sync <range> --json、oma docs i18n --json、oma docs lint --json。sync 未给范围时依次使用暂存改动、HEAD~1..HEAD。参数与输出文件见 resources/commands.md。

依赖与产物:oma docs CLI、Git、仓库文档;lychee 可选用于 URL 校验。verify 会重新生成 docs/generated/doc-refs.json,可选 URL 结果写入 docs/generated/url-drift.json;sync 的 CLI 只输出候选数据,由宿主起草并应用补丁;i18n/lint 仅报告。docs.auto_verify 启用时工作流钩子仅告警。

限制与注意:CLI 缺失时须说明自动检查不可用,改为人工检查并标注“manual inspection — oma docs verify did not run”,不得伪装成 CLI 输出,也不得把安装 CLI 作为前提。lychee 缺失或 URL 扫描不完整时报告未验证范围;单个文档无法解析则记录跳过并继续;补丁无法应用时重读当前内容做等价修正;索引写入失败须如实报告。补丁与报告须排除含密钥文件(.env*、私钥、凭据),遵守忽略块、oma-docs: skip 与配置排除项,被 gitignore 的运行时产物缺失按跳过处理。应用本地化修正时保留语言、术语与占位符。干净的引用扫描不代表语义正确或翻译质量完整。