How do you manage multi-project documentation?

#discuss #documentation

At work we have lots and lots of software projects and we believe having good documentation makes us more efficient and the code more maintainable.

The problem is how to manage this documentation. We used to have a central wiki system where we would document projects but because it was disconnected from the code, the docs got outdated.

We run our own Gitlab instance so we decided to move documentation into the Gitlab projects where we'd write quick intros and get-the-project-running docs in a README file and more detailed docs in the project wiki. That allowed the docs to be closer to the code and at least the READMEs checked via merge requests.

But non-code docs (processes etc.) are then more difficult to manage. We have some documentation repos to get around it, and a central doc repo with links to all the other repos and their docs.

How do you manage documentation for multiple projects?

Photo by Viktor Talashuk on Unsplash

Speedy emails, satisfied customers

Are delayed transactional emails costing you user satisfaction? Postmark delivers your emails almost instantly, keeping your customers happy and connected.