Good Documentation Tip #2

Learning new things is fun! You get to not know the answers and fiddle around to your hearts content. The only thing that can take the child like joy of learning is to have documentation that is so horrendous that you feel stupid, ashamed and fearfully shocked that you can’t get this simple task done.

This happened to me. No lie, bare truth, clear of additives. Below is the example that left me totally bewildered.

34. Set the graphics format to GIF and use the Filter Setting button to set the resolutions to 80x80. Click OK

Seem easy. Two steps and hit OK. Anyone can do that right? Wrong. Graphics format I got through, but then suddenly there is no resolution option. I was completely lost and had nowhere to go. This is not the motherly guidance I was dreaming of, this was slapping a German script in front of me with 5 min to curtain. I can’t read German and that’s not the point. Below is my humble rewrite.

5. In the Graphics section, select GIF in format dropdown
6. Select Filter Setting button, settings window will open
7. In Screen Resolutions section, default value 80x80
Large images = 64x64
Small images = 90x90

Each action is given the respect it deserves in a unique step. Honest labeling is used and expectations are given so the reader is not left hanging. If the reader gets lost, it’s the fault of the documenters and they should be hang their heads in shame.

Tune in tomorrow for Tip #3…