4 ms·
Just from the top of my head: For internal docs, focus more on “why”. Explain why the software exists & what problem it solves. Why the design decisions were
by closet_ninja 6y ago
Just from the top of my head:
For internal docs, focus more on “why”. Explain why the software exists & what problem it solves. Why the design decisions were made. Why the trade offs were good (at the time, since systems change and evolve).
If you have meeting notes, attach it as an appendix with list of stakeholders involved.
List known dependent services and clients.
Start with the big picture and describe the interaction between components/services. Then have each section drill down into the components.
If this is a wiki page or a living document, add links to various dashboards, metrics, CI/CD, repos, Jira, etc. list of stakeholders.
If this is internal to the company but other teams can access it, have a section on how others team can do some preliminary debugging. How to contact your team (ticket? Slack? Email?).
In general, I don’t think I’ve seen bad documentation per se. any documentation helps. It’s just that they get outdated and become misleadinng. Instead of focusing on wiring a perfect doc the first time, I think it’s more important to keep it up to date.