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

Codex documentation 技能安装与用法：编写团队运行手册

English

Codex 安装步骤

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

中文摘要

按读者需要编写 README、运行手册和入职指南，未指定存放位置时使用项目的文档目录。

SKILL.md 中文导读

可复现示例

调用 documentation，根据下面这份虚构的截图维护交接单，给文档编辑编写一份运行手册。
topic=refresh the product-guide screenshot
when=an approved image has changed | prerequisite=approved replacement image plus local preview
steps=replace the image; confirm the product guide preview and alt text
rollback=restore the prior image | escalate=send a preview mismatch to the documentation editor
fixture input `shot-guide-42` | file `product-guide-new.png` | preview check `alt_text=Export orders`

工作步骤

  1. 说明读者、文档类型及目标位置。
  2. 将已知场景和维护输入改写成读者可执行的步骤。
  3. 从适用场景到上报路径逐节检查，确认回退后能恢复原图。
  4. 记录截图替换和回退步骤，检查图片替代文本。

验收方法

写出 `/docs_ocode/screenshot-refresh.md`，交代适用场景、准备条件、替换与预览、回退和上报。验收在预览中核对 `product-guide-new.png` 和 `alt_text=Export orders`，回退引用 `restore the prior image`。

GitHub 原文 · 更新日期

适用环境

能在本地项目写 Markdown 的 Codex 工作区。团队运行手册的示例使用下方已给出的角色和输入。

常见问题

能将运行手册写入团队已有的文档目录吗？

可以，明确提供目标路径。未指定路径时，技能把文档写到 `/docs_ocode/` 下。

相关指南