Software Documentation© Janice Karin
- Lesson 3: The Importance of Word Choice and Consistent Writing
Lesson 5: Using Tables and Graphics
Using representational drawings
Just as screenshots can help your users better understand procedures and how to navigate through the user interface of the product you're documenting, representational drawings can help them understand conceptual material. Spending three pages describing the product architecture in detail is all well and good, but without a diagram showing how your application server sits above the database but behind the webserver even a lengthy description may not register with your users. Again, as with screenshots, representational drawings cannot take the place of the actual written discussion. Without text to frame the drawing your users won't know what they're looking at or why they should care. You need both elements working in concert.
1
2
3
4
5
6
Print this page
|