Software Documentation

By Janice Karin

Lesson 5: Using Tables and Graphics

Lesson Summary

Graphics - screenshots, representational drawings, and tables - are an important part of technical writing. The key is to use them appropriately. Determine when they are needed and when they aren't. Make sure they fit the topic you're discussing and that you provide a short but informative caption for each graphic. Most importantly, make sure that you don't add graphics just for the sake of having pretty pictures in your book.

Print this Page Print this page


Previous Page  1  2  3  4  5  6 


Lessons

Lesson 1: What is Technical Writing?
Lesson 2: The Importance of Audience
Lesson 3: The Importance of Word Choice and Consistent Writing
Lesson 4: Writing Procedures
Lesson 6: Indexing Your Documents
Lesson 7: Editing And Reviews
Lesson 8: The Tools of the Trade