ai-write
Skill65 starsChanged 2 months agoApache-2.0View on GitHub
Writes technical documentation for this repository: a README, a wiki page, product documentation, API docs or a technical post. Applies the framework's single writing standard (`references/documentation-writer.md`) and verifies every document against the tree. Trigger for \"write the README\", \"update the wiki\", \"document this API\", \"write a technical post about\", \"refresh the docs\". Not for the changelog. Not for a feature plan — use /ai-orchestrator. Not for a finding — use /ai-note. Not for an issue or incident report — use /ai-issue-report.
In this repository41 other files it gives its agents.
- AGENTS.mdAGENTS.md
- a11y-auditSkill
- ai-adversarial-loopSkill
- ai-agents-mdSkill
- ai-architectSkill
- ai-audit-codeSkill
- ai-audit-designSkill
- ai-audit-docsSkill
- ai-brainstormSkill
- ai-codegraphSkill
- ai-config-to-projectSkill
- ai-debugSkill
- ai-design-md-plannerSkill
- ai-exploreSkill
- ai-git-cleanupSkill
- ai-issue-reportSkill
- ai-noteSkill
- ai-orchestratorSkill
- ai-prototypeSkill
- ai-prSkill
- ai-read-docsSkill
- ai-researchSkill
- ai-review-uiSkill
- ai-securitySkill
- ai-stress-testSkill
- ai-test-plannerSkill
- ai-triageSkill
- ai-verifySkill
- ai-visual-recapSkill
- ai-writing-behaviorSkill
- build-checkSkill
- code-auditSkill
- design-checkSkill
- feature-verifySkill
- full-reviewSkill
- perf-auditSkill
- review-routerSkill
- second-opinionSkill
- security-auditSkill
- spec-extractSkill
- verify-featureSkill
The file
We split this skill into the rules it gives an agent
9 rules. About 0 are common, 5 are distinctive, and 4 are very specific to this project.
≈0
Common · estimate
Many files like this have a rule of this kind.
≈5
Distinctive · estimate
This author's own choices. Worth a look.
4
Very specific
Tied to their project's names, files or tools. Probably skip.
- Common
- Distinctive
- Very specific
- Distinctive: line 18
Read the voice: references/voice.md.
- Very specific: line 21
If either file is missing, stop and say INCOMPLETE: writing standard absent.
- Very specific: line 26
Read the tree the document is about.
- Distinctive: line 29
Write and keep it a document, not a cache.
- Very specific: line 33
Verify before done. Walk every named file and command.
- Distinctive: line 36
Write only into the homes the user named (README.md, docs/, a wiki dir).
- Distinctive: line 41
Not the changelog; not a feature plan (/ai-orchestrator).
- Very specific: line 53
Every named file exists and every named command runs, no passage restates the environment, every section ends on a checkable criterion, …
- Distinctive: line 78
Read by: humans and the surfaces Dies: when the code it documents dies Next: none
≈ “Common” is an estimate: at least 1 in 5 of the 350,495 skill files we read have a rule of the same kind, not the same words. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.
Files
Write documentation with the framework's gates
What it produces
One document — a README, a wiki page, product documentation, API docs or a technical post —
written against the framework's single standard and verified against the tree: every named
file exists, nothing restates what the environment already says, and each section ends on
a checkable completion criterion. A document that cannot be verified exits not-covered: <reason>.
Steps
- Read the voice: references/voice.md. The reply to the
person, and the opening of the document, follow it. Then read the writing
standard: references/documentation-writer.md.
If either file is missing, stop and say
INCOMPLETE: writing standard absent. Then read the reference for the artifact at hand: references/readme-writer.md for a README, references/contributing-writer.md for CONTRIBUTING, a code of conduct or a release flow, and references/security-md-writer.md for SECURITY.md. - Read the tree the document is about. Not from memory, not
--help. The README names commands that exist. The API doc names endpoints in the code. The wiki names directories on disk. Every claim traces to a file or a command. - Write and keep it a document, not a cache. Never restate the environment (config, CLI output, directory layout). Never repeat the spec or the ADR it points at. One idea per sentence. One meaning per word. Every section ends on a checkable criterion ("the command in section 2 runs", never "the reader understands").
- Verify before done. Walk every named file and command. A missing file or a command that
does not run is a finding against the document. A passage that could not be verified
exits
not-covered: <reason>. Never invent to make a section pass. - Write only into the homes the user named (README.md, docs/, a wiki dir). The change lands through the normal review. This skill never approves its own document.
What this is not
Not the changelog; not a feature plan (/ai-orchestrator); not a finding (/ai-note); not an issue
or incident report (/ai-issue-report). And it is not a licence to repeat the environment: a
document that restates --help or the config is a cache, and a cache earns its load only
when the lookup is expensive.
- "The reader will understand it from context" — a completion criterion is not a feeling:
if a section cannot be checked against a file or a command, it gets a
not-coveredreason, and a doc that claims to be verified when it is not is the false-green this framework exists to stop.
Done when
Every named file exists and every named command runs, no passage restates the environment,
every section ends on a checkable criterion, anything unverifiable carries a not-covered:
<reason> exit, and the user's named home was the only place written. The doc is a claim;
the tree is the evidence.
The ai-engineering seam
- Two files, two jobs. references/voice.md is how a reply or a handoff is shaped. references/documentation-writer.md is the prose standard for every surface that writes for humans: incident reports (/ai-issue-report), AGENTS.md authoring (/ai-agents-md), and any README the framework installs. Voice does not relax a checkable completion criterion.
- ai-write never writes into
.ai-engineering/— governance artifacts are not product docs. Its home is the tree the user names: README.md, docs/, a wiki directory. - The verdict on whether a draft is good belongs to the
decidetier; the mechanical checks (every named file exists, every named command runs) belong toverify(.ai-engineering/config.tomlpin).
Lifecycle
Lane: standard, full Trigger: public-interface Trigger kind: judgment Trigger when: the diff changes a public interface, a documented behaviour or a command a README shows Writes: README.md, docs/ Read by: humans and the surfaces Dies: when the code it documents dies Next: none
Does it work?
Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.
No reviews yet
People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.
- It worked
- Partly
- It didn't
Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.
Your trail
Files you open will collect here, so you can find them again.
Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.
Now do this for your own.
Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.

