“Hello! I am a developer. Here is my relevant experience: I code in Hoobijag and sometimes jabbernocks and of course ABCDE++++ (but never ABCDE+/^+ are you kidding? ha!) and I like working with Shoobababoo and occasionally kleptomitrons. I’ve gotten to work for Company1 doing Shoobaboo-ing code things and that’s what led me to the Snarfus. So, let’s dive in!
I structure my tutorial docs (I write a lot of them for work) like the O’Reilly cookbook series for this reason.
The problem you’re trying to solve is at the top. Next comes a list of prerequisites for the instructions. Then clear, step-by-step instructions with no more than one command or action for each one, highlighting anything that’s different depending on environment.
Then at the bottom I’ll sometimes add a discussion of why each command does what it does, and finally a list of resources for whatever programs or systems the instructions are about.
Thank you for that. I’m sure the people who read it and got a grasp of what they are trying to accomplish greatly appreciate your going out of the way like that. :-]
Usually it’s to help a customer create a proof of concept going so we can make a sale so it’s not entirely a selfless act.
Plus it keeps me from sitting on hours-long calls trying to walk them through ambiguous instructions.