القائمة
Documentation writing for repo docs, READMEs, guides, runbooks, ADRs, API docs, and inline explanatory docs. Use when the user asks to write, update, edit, tighten, or review documentation.
التثبيت باستخدام Codex أو Claude انسخ هذا Prompt والصقه في Codex أو Claude أو مساعد آخر ليراجع صفحة Skill ويثبّتها لك.
استنادا إلى تصنيف SOC المهني
Use when work may edit files, push branches, open or update pull requests, wait for CI, merge changes, or modify issue state, especially when the prompt is terse or says AFK, take to completion, fix and merge, or do not stop.
Use when two or more pull requests must be rebased, repaired, validated, queued, merged, drained, or coordinated as a set, especially for prompts such as take all open PRs, merge every PR, drain the PR queue, or orchestrate PRs.
Use when an existing pull request must be diagnosed, rebased, repaired, pushed, brought through CI, queued, or merged, including prompts such as fix this PR, rebase on main, fix CI, push back, CI pass, or merge.
Default delivery workflow for tracked repo changes. Use when the user asks to fix, add, implement, update, refactor, rename, bump, tweak, or otherwise end in a file change. Do not use for read-only questions or investigation.
Drain the ready-for-agent GitHub issue backlog: claim the oldest unclaimed issue via the lock-branch protocol, ship it through tdd-ship, label the outcome, repeat.
Review a GitHub PR of this repo: description accuracy, code quality against the project dev-skill standards, and a bug hunt with concrete failure scenarios.
| name | write-documentation |
| description | Documentation writing for repo docs, READMEs, guides, runbooks, ADRs, API docs, and inline explanatory docs. Use when the user asks to write, update, edit, tighten, or review documentation. |
Write docs that help the reader act, then ship them through tdd-ship like
any other tracked change.
docs/README.md — index of technical docs. New technical docs go in
docs/ and get a row in its table.docs/adr/ — Architecture Decision Records. Copy 0000-template.md to the
next sequential 4-digit number, fill the template fields (Status, Deciders,
Context, Drivers, Options, Consequences), and add the ADR to the index in
docs/adr/README.md.docs/user-guide/ — markdown mirror of the end-user guide. The published
copy lives in website/docs/; when you edit one, update the other.website/docs/ — source of the published site (docs.lihor.ro). Pushes to
main touching website/** deploy it via .github/workflows/docs.yml
(GitHub Pages).docs/SELF_HOSTING.md — running your own instance./api/changelog) is AI-generated at
release time — never hand-edit CHANGELOG.md as documentation; see the
release skill.Identify the reader, task, and source of truth. Completion: you can name who reads the doc, what they need to do, and which files, code paths, specs, or user notes prove each claim.
Gather facts before drafting. Completion: every non-obvious claim is backed by current source material or marked as an assumption.
Draft around the task. Completion: the doc starts with the needed answer, then gives only the context, steps, decisions, or constraints the reader needs. Warnings and limits sit next to the step or fact they affect, not in a separate section.
Prune hard. Completion: each sentence changes what the reader knows or does; headings are not restated as prose.
Verify the result.
Completion: commands, paths, option names, links, and examples are accurate;
formatting and terminology match nearby docs; any mirrored copy
(docs/user-guide/ ↔ website/docs/) is updated in the same PR.