Hey
@Terry Davis!
I used to work at GoCardless (~700 person fintech unicorn) working on their internal developer platform.
One of the biggest things we did to improve documentation, and one I recommend without reservation to people nowadays, is to agree on a structure and create templates for it.
The one we use is:
https://documentation.divio.com/
We maintained a doc space for all infra tools that split docs by this type, and templates for each different type of doc.
Itās a massive step forward for doc-writer (and reader!) productivity, as it avoids the āblank pageā problem and helps set guidelines on the type of effort required for whatever youāre writing. It also helps when discussing investment in docs, as you have a shared concept of how much effort should go into a how-to (<1-2hrs) vs a tutorial (days).
We use this at
incident.io now (attaching a screenshot of our Guides database, which splits docs like this) and the blog post I wrote about our Getting Started tutorial, which links to the tutorial:
https://medium.com/gocardless-tech/deploying-software-at-gocardless-open-sourcing-our-getting-started-tutorial-ab857aa91c9e