Technical Documentation Check-List

Your manual will be perky if you can answer YES to the following: Does the manual describe the procedures after the version update? Do the procedures work? Have the screen-captures been updated to show the current running version? Have the screen-captures been updated to show available new options, pop-ups and floating windows? In cases where windows canContinue reading “Technical Documentation Check-List”

How to write a QUICKSTART: “Colorful is nice but aim for Gold”

Don’t tell ‘the story’: Implement a step structure using a Font Set or other Formatting. Use Callouts and Arrows: Show What & Where to systematically cut reading time. This is not the place for Concepts: Rather give an Example and “shoot for gold”. Addressing Issues:  Do this in your Blog Space or References to other subject matter written elsewhere. Everything should beContinue reading “How to write a QUICKSTART: “Colorful is nice but aim for Gold””

To Publish or Not To Publish – That is the Question

Happy Passover 2016, Your User Guides took long to write, due to development issues and the fact that your service people are on-site at the Customer. Finally you have reached the promised land and the Guide is ready. So how are you publishing your Manuals? All too often, the User Guide is sent directly toContinue reading “To Publish or Not To Publish – That is the Question”