SuperAPI AI 工具集

oma-docs

写作与研究

查看项目

更新于 10-15 21:55

技能介绍

用途:保持仓库文档与实际行为一致,并报告验证的局限。适用于仓库文档验证、基于 diff 的同步和翻译维护;一般源码研究、应用实现或已知文本翻译应改用其他对应技能。

模式与用法:需要指定模式(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。

主要能力:verify 提取并解析引用后汇总报告;sync 获取候选、读取相关文档与 diff,仅应用已授权的修正;i18n/lint 报告漂移或风格问题。审查类请求只产出提案,已有范围编辑授权可直接应用修正。验证会重新生成 docs/generated/doc-refs.json,可选 URL 结果写入 docs/generated/url-drift.json。

依赖:oma docs CLI、Git(用于基于 diff 的工作)和仓库文档;lychee 为可选 URL 验证工具。

限制:引用扫描通过不代表语义正确或翻译质量完整。CLI 缺失时需明确说明自动检查不可用并改用手工检查,不得将其作为 CLI 输出。缺少 lychee 或 URL 扫描不完整时需报告未验证范围。单个文档解析失败应记录跳过并继续。补丁不适用时需重读当前内容做等价修正。索引写入失败需如实报告。不得在报告中暴露含密钥的文件;CLI 只产出结构化数据,由宿主进行自然语言综合,不得编造 CLI 结果。需遵守 ignore 块、oma-docs: skip 与配置排除项;被 gitignore 的运行时输出缺失应跳过而非视为坏引用。本地化修正需保留语言、术语和占位符。

其他细节:资源参见 resources/commands.md(仅对应所选操作)、../oma-translation/SKILL.md 和 ../_shared/core/execution-policy.md。