Services · Run
Technical documentation
Clear, accurate documentation for developers, operators and users, written from the real running system.
Documentation goes stale when it lives apart from the software it describes. We write it from the code, the running system and interviews with your team, then store it beside the code so it is reviewed and updated with each change. Developers get API references and architecture guides, operators get run-books, and users get task-based manuals.
What you get
- API references generated from OpenAPI specs, with worked request examples
- Architecture overviews with diagrams of components, data flows and dependencies
- Operations run-books for deployment, backups, incidents and common fixes
- Task-based user guides with screenshots for each main role
- A developer onboarding guide that gets a new engineer building locally
- A searchable documentation site published from your repository
How it works
- 01
Audit
We review existing docs, code and tickets to find what is missing, outdated or repeatedly asked about.
- 02
Plan
We agree the readers, the documents each one needs, and the structure, tone and tooling to use.
- 03
Write
Drafts are written from the real system, checked by running each step and reviewed by your engineers.
- 04
Maintain
Docs are added to your repository and pull request checks, so updating them becomes part of every change.
Scope it now.
Answer a few questions and we prepare the email for you. Nothing is sent until you press send in your own email app.
Prefer to write freely? hello@clockborn.com
Questions
Can documentation be generated automatically?
Partly. API references can come from OpenAPI specs and code comments. But the explanation of why the system works the way it does, and how to fix it in the middle of the night, has to be written by someone who has studied it.
Which tools do you use?
Usually Markdown in your repository, published with a static site tool such as Docusaurus or MkDocs, with diagrams as code in Mermaid. If your team already works in Confluence or Notion, we can write there instead.
How do the docs stay current?
We keep docs in the same repository as the code and add a documentation item to your pull request template. Changes that alter behaviour then update the docs in the same review, not months later.