I had to write one of this (actually 3 one for each project/simulator), please note a simulator in this context is just a peace of code that will push a lot of load into the application, “simulating” another application…
Anyway I had this nice outline of the doc first an explanation of what it does, then what it’s build on (tecnology, APIs,etc), then what it was it’s input data and then the most “interesting” part how to run it.
Now this got me thinking why we need such a useless peace of information? isn’t this what the README file is for? This document is not for end users they couldn’t care less, and this document isn’t for managers either because they care even less 
So the goal of this is that when I’m gone someone will take over development of the code now for that guy or gal (yes we have some woman at work) I have written code and comments so my question is what developer will read a word file telling him what the application does?
1 comment so far ↓
Instruction Manual’s Manual:
—————————————
First Step: Attempt to use the application, see if it ‘Just Works’ (TM).
Second Step: Recover damages from first step, barely read the documentation, then try again.
Third Step: If you are still alive, and whatever-it-is-you-are-trying-to-use still seems functional, RTFM.
Leave a Comment