3 ms·
> You should write three types of documentation. One for users, one for admins and one about architecture. I use an airplane analogy (different order than your
by alexpotato 3y ago
> You should write three types of documentation. One for users, one for admins and one about architecture.
I use an airplane analogy (different order than your three above):
1. "Congratulations on purchasing your 747"
2. "This is how you replace the auxiliary power unit"
3. "This is how you survive the engine catching fire"
- remram 3y ago1 is not documenting anything, and both 1 and 3 are meant for pilots? Who are the "users" in this analogy?
- nwatson 3y ago"1" is for the airline. What does purchasing the plane, or a fleet of such planes, mean to the company? What will be the benefits, duties, obligations wrt to the airplanes, at a high level? Edit: word choice
- JdeBP 3y agoOn the contrary, 1 would be a "quickstart guide", a "welcome pack", or even just a "The first thing that you need to do to your new washing machine/jet aircraft is take the restraining bolts, used for immobilizing it during transport, off."