Codex documentation skill setup and a team runbook
Write reader-focused READMEs, runbooks, and onboarding guides. Use the project's documentation directory when the request does not specify a destination.
中文Install in Codex
A Codex workspace that can write Markdown in the local project. Use the roles and inputs below for the sample team runbook.
- Review `agdocumentador/.agents/skills/documentation/SKILL.md` and its requirements at the pinned GitHub commit.
- Create `.agents/skills/documentation/` in your project and save the reviewed file as `.agents/skills/documentation/SKILL.md`.
- Start Codex from that project's root, then type `$documentation` and select the matching skill.
Example task
Invoke documentation with this fictional screenshot handoff and ask for a runbook for documentation editors.
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`What to check
Create `/docs_ocode/screenshot-refresh.md` with when to use it, prerequisites, replacement and preview steps, rollback, and escalation. Verify `product-guide-new.png` and `alt_text=Export orders` in the preview; rollback uses `restore the prior image`.
Original SKILL.md on GitHub · Updated
Frequently asked question
Can I use my team's existing docs directory for the runbook?
Yes. State the destination explicitly. With no destination, the skill writes the document under `/docs_ocode/`.