Tech writer role
Owns product and developer docs alongside the code.
Automations · Living Docs
Docs that never go stale.
Documentation has owners on the team, and a missing doc is a finding like any other.
Live in productionTime
PRPR #91 changed the /invites APIexample
illustrative
What is Living Docs in agnte?
In agnte, tech writer and API docs roles own the documentation. When code changes leave a doc out of date or missing, that gap is raised as a finding and routed to the docs owner to fix.
Capabilities
What Living Docs does
Time
API docs role
Keeps API documentation aligned with the OpenAPI spec.
Doc gaps are findings
Missing or stale docs enter the same ledger as bugs.
Reviewed like code
Doc changes ship in pull requests and get reviewed.
How it works
How Living Docs works
- Code changes
- Gap detected
- Docs role updates
- Reviewed in a PR
FAQ
Questions about Living Docs
Who writes the docs?
The tech writer and API docs roles, working from the same project memory as developers.
How does agnte notice stale docs?
Doc gaps are raised as findings during reviews and testing.
Are doc changes reviewed?
Yes, they ship as pull requests like code.
Related