We are currently rewriting our internal web-based application and I am looking for good technical documentation templates to use. Something like date, author, description, purpose, etc... Any suggestions?
2007-06-11 01:51:40 · 1 answers · asked by to_the_hurricave 3 in Computers & Internet ➔ Programming & Design
Believe it or don't...my sincere and most honest suggestion to you, if you truly care about the usability of your documentation, is NOT TO USE A DERNED TEMPLATE!!! Think about what the user needs to know, and how easy it is to find and understand what you have to say. Compare THAT to crummy manuals such as those presented by Adobe Photoshop, Gimp, Microsoft Word, and such. These manuals really suck.
I'm completely serious here, and I have experience at both ends, as writer and user. Users have great gratitude for manuals that have gracious indices, and simple and easy-to-read answers to their questions, and instructions to the procedures they need to know!
Consider these things. Look at such books as "Designing Web Usability" and "Don't Make Me Think" for similar concerns. Don't design your manual like a government form!.
2007-06-11 05:40:37 · answer #1 · answered by fjpoblam 7 · 0⤊ 0⤋