Software
Documentation close to the code
Interfaces and flows described and updated when the code changes, instead of a wiki that lies.
How you work it in Colleag
- 1
Ask the colleague to describe a flow or interface.
- 2
The colleague reads existing documentation and the changes and drafts the description.
- 3
Review against the implementation.
- 4
Approve; at the next change the colleague proposes the update.
A worked example
“Describe how the cloud sync flow works after the latest change.”
An updated flow description with the changes marked, built on the old description and the changes. Where code and document contradicted each other it is flagged instead of silently chosen.
Screenshot from Colleag. The example uses invented figures.
The material
- Existing flow documentation
- The changes since the description was written
- Interface documents
You approve
Everything the colleague produces is a proposal with sources. Nothing is published, sent or saved to the archive without a human approving it, and every figure traces to its material.
Curious what it feels like?
We run pilot programs with a few manufacturing companies at a time. Tell us about your business and we will show what the colleagues can do with your documents and your data.