3 ms·
"Documentation needs to include and be structured around its four different functions: tutorials, how-to guides, explanation and technical reference." I'm a sy
by blakesterz 7y ago
"Documentation needs to include and be structured around its four different functions: tutorials, how-to guides, explanation and technical reference."
I'm a sysadmin and most of the documentation I write is... well it's for me! I do something once and I know I'll do it again, I copy and paste everything I did into our "docs" area so I can just copy and paste it again. I guess that falls under tech reference. My theory for these docs is if I'm not around, someone else should just be able to copy and paste things and not need to learn my job. Doesn't apply to EVERYTHING, but it helps for all the little things.
- Angostura 7y agoPresumably, someone else is writing the other 3 types of documentation for the actual users?