3 ms·
I've found documentation on commands for running tests, running scripts, and running other manual processes useful even if I've run the commands before many tim
by s12345 8y ago
I've found documentation on commands for running tests, running scripts, and running other manual processes useful even if I've run the commands before many times, and even if I was the one who created the commands. Documenting anything you find yourself looking up a lot online, or in your Terminal history would probably be useful even at the beginning just to reference for myself.
As time goes on and the company grows, I think reasoning becomes useful to document. Why were technical decisions made in code changes, why were tasks deprioritized, why did tasks grow in scope or reduce in scope over time?
- cborenstein 8y agothanks for sharing - that makes sense. Where do you usually write your runbooks? In a google docs/confluence type wiki or with your code? How do you organize them so that you can find/share them quickly?
- s12345 8y agoWe write our runbooks in a wiki in Phabricator. We have a wiki per topic-- we have one for getting started with the system that has some useful commands for running tests, another for deploying the system, etc. I usually find them by searching for terms that I remember are in them, but starting out, I was sent some of the wiki pages.