3 ms·
There are 3 primary types of documentation that a growing organization needs : 1. Onboarding 2. Runbook / Troubleshooting 3. Notes and ongoing developer wi
by aorloff 9y ago
There are 3 primary types of documentation that a growing organization needs :
1. Onboarding
2. Runbook / Troubleshooting
3. Notes and ongoing developer wisdom
Slack helps with #3, but is not what #1 and #2 require.
New hires should not be digging through slack to get up to speed, and ops or engs trying to deal with catastrophe in the wee hours should have playbooks, not try to dig up what worked last time in slack.
- awinter-py 9y agodo you have any recommendations for good runbook tools? I'm on the market for one of these.
- softawre 9y agoa wiki?
- aorloff 9y agoYeah a wiki should suffice. Having a good runbook is a process that needs to be tended to every time devs and ops deploy, troubleshoot, and configure services. More of a process than a tool, because it should integrate with all the tools already in use for deployment, logging, debugging, etc.