All use cases
Platform engineering
Documentation that is wrong in the pull request, not in production
TechDocs built from the repository, published beside the service it describes.
Before Fenwave14 months waiting
“Is this runbook still accurate? Last edited 14 months ago by someone who has left”
What the wait costs
Documentation stored away from the code decays silently, and is trusted exactly until the incident where it matters.
TechDocs are written as Markdown in the repository and published against the catalog entry for that service. The documentation and the code travel in the same pull request, which means a reviewer can see that a change made the runbook wrong — at the only moment when fixing it is cheap.
How it works
- 01Write documentation as Markdown alongside the code.
- 02Fenwave builds and publishes it against the catalog entry.
- 03Readers find it from the service, not from a separate wiki search.
- 04Changes to docs are reviewed with the code that caused them.