词映 AI导航
工具库Skills 技能
我的收藏
词映 AI导航

Codex documentation-sync 技能安装与用法：核对项目文档与实现

English

Codex 安装步骤

  1. 打开 GitHub 固定提交的 `.agents/skills/documentation-sync/SKILL.md`，核对内容与使用条件。
  2. 在自己的项目中创建 `.agents/skills/documentation-sync/`，把核对后的文件保存为 `.agents/skills/documentation-sync/SKILL.md`。
  3. 在该项目根目录启动 Codex，输入 `$documentation-sync` 并选择同名技能。

中文摘要

对照构建文件、工作流和架构记录找出过时说明，并提出可单独处理的文档改动。

SKILL.md 中文导读

可复现示例

调用 documentation-sync，检查下面虚构的项目导出格式核对记录，写出文档改动计划。
fixture `guide-audit-26` | workflow example: list supported export types
README example `format=csv` | build configuration `format=json`
quality note=verified local preview supports JSON export only | proposed scope=correct walkthrough only

工作步骤

  1. 盘点 README、开发要求、质量说明、工作流、架构和示例。
  2. 逐条检查文档里的操作约定与构建配置，标出过时的导出格式。
  3. 按证据提出文档改动计划，必要时应用配套治理技能。

验收方法

在 README 示例中标记 `format=csv` 已过时，引用构建配置和已验证的预览，将更正建议写为 `format=json`。文档改动计划仅包含这份操作说明。

GitHub 原文 · 更新日期

适用环境

Codex 可以读取项目的 README、AGENTS.md、QUALITY.md、工作流、架构记录和构建文件。本示例只复核一个已给出证据的文档差异。

常见问题

当实现行为没有证据可核实时怎么办？

暂停相关更正建议并标出缺少的证据。涉及流程或架构规则时，结合项目配套的治理技能核对。

相关指南

相关推荐