Software Documentation


© Janice Karin

Lesson 5: Using Tables and Graphics

Using screenshots

Sometimes a picture really is worth a thousand words. No matter how well you describe the user interface of a product, there's really no replacement for showing your users what it actually looks like. You need to describe things too - screenshots aren't a replacement for proper discussion - but sometimes an illustration can help your text make more sense.

As with tables, you don't want to overuse screenshots. If an entire section is devoted to the same tab of your application, you generally don't need to present a visual image of that tab every time you ask your users to do something within that tab. If you present the same picture six times within a single procedure it merely serves to slow down the process, spread the information out over multiple pages, and interrupt their train of thought.

In general unless they are small graphical representations of buttons or active screen elements, it's best not to include any screenshots or other illustrations within a procedure. Provide any necessary graphics before you get into the procedure so your users can refer to them as needed without having them interrupt the procedure itself.



Previous Page  1  2  3  4  5  6   Next Page

Print this Page Print this page