Docs gardener & API doc writer
On the schedule you choose, the agent diffs shipped changes against the docs, drafts the reconciling updates and API endpoint docs typed to the real response, edits for clarity, and drafts a PR — so docs never silently drift from the code.
Saves you ~5 h / week
How it works
- Trigger
- On the “Garden docs” schedule.
- Job
- Diff changes against docs, draft the reconciling updates, edit, and draft a PR.
- Outcome
- Accurate documentation updates and a pull request draft.
What it installs
Agents 2
-
Docs Agent
Reconciles docs with shipped changes, writes API reference, and drafts a pull request.
-
Docs gardener & API doc writer Quality Reviewer
Checks primary evidence, domain controls, deliverable completeness, and communication quality, stopping the run when the work is wrong, unsupported, incomplete, or uncertain.
Teams 1
-
Docs gardener & API doc writer quality team
The delivery agents produce the work while an independent quality reviewer checks each workflow handoff against explicit evidence, domain, and communication requirements before the run can continue.
Workflows 1
-
Garden docs
Diff changes against docs, draft the reconciling updates, edit, self-review, and draft a PR.
Goals 1
-
Docs never stale
Documentation stays in sync with what the code actually does and reads well. Success looks like: Each run lands an approved PR that reconciles every doc delta with shipped changes, with API reference typed to the real response and no stale claims remaining.
Skills 3
-
document-api-endpoint
Document and type an API endpoint against its real worker response: confirm actual behaviour, correct type drift, be precise about nullability, reuse the canonical type, and migrate legacy reference docs whole. Adapted from getsentry/skills/document-api-endpoint.
-
doc-coauthoring
Write and maintain technical documentation for a real audience: pick the right document type, lead with what matters, show with examples, link rather than duplicate, and keep it current. Adapted from anthropics/knowledge-work-plugins/documentation.
-
edit-article
Edit technical prose by ordering sections to respect their dependencies, then rewriting each for clarity, coherence, and flow with tight paragraphs. Adapted from mattpocock/skills/edit-article.
Schedules 1
-
Garden docs
Reconciles docs with shipped changes on the schedule you choose. ## Professional quality control Objective: complete the recurring Docs gardener & API doc writer operating cycle and deliver a review-ready, evidence-backed result rather than merely report that the schedule ran. Start by fixing the review period, reading the current source records and prior run, confirming required access, and listing missing or contradictory inputs. Execute the bundle's full authored method in order, retaining source, calculation, command, or before/after evidence for load-bearing findings. Separate facts from interpretation, apply supplied policy without inventing thresholds, and stop any branch that requires missing authority or an unconfirmed human rule. Produce the complete named deliverable plus an evidence record, assumptions, exceptions, unresolved questions, and concrete next actions with owners where the method calls for them. Run the workflow's independent verifier checks and fix failures before requesting approval. The task is done only when every requested section and quality criterion passes or a blocker is explicit; silence, inaccessible data, or polished prose is not proof of completion. Inspect the repository and actual diff, reproduce the behavior, run the declared tests and checks, cover known success and error paths, and verify security, performance, migration, and rollback implications where relevant. Never infer a passing command. Technical prose must cite command output and avoid generic AI phrasing or claims that the code does not prove. The human retains authority over publication, sending, spend, signing, merging, deployment, and other consequential external actions.
Requirements
- Connected repository — Needs a connected code repository so the agent can diff shipped changes against the documentation, confirm endpoint behaviour, and open a documentation pull request.
Setup guide
How to Keep Docs Current
A practical guide to reconciling documentation with shipped code through scheduled diffs, API checks, draft PRs, and approval.
Read the setup guideDon't see your workflow? Describe it.
A sentence or two about a recurring job is enough. We design the playbook that runs it and show you exactly what it saves.