User:Pavithraes/Sandbox/Graphics in technical documentation
Overview
editTechnical documentation provides explanations and descriptions of technical projects, products or processes. Sometimes, graphics can help communicate this information more clearly and more accurately than text alone. We discuss some graphics that can be used and how to use them best.
Purpose
editGenerally, graphics are used in technical documentation for one of the following purposes.
Purpose | Description | Example |
---|---|---|
Support text | Graphics used along with textual information to validate it. | Photos used with a story to prove authenticity |
Replace text | Graphics used instead of text to communicate some information. | Using an illustration of agile development instead of plain writing. |
Augment text | Graphics used along with textual information enhance its impact. | Comparative analysis graphs used with text. |
Images
editSee also: Help:Images
Always add a caption and/or a description of the image to improve the accessibility of the document.
Types | Description | Usage tips | Example |
---|---|---|---|
Photographs | A picture, usually representing a scene or an object, taken using a camera. |
|
|
Screenshots | A captured computer screen displaying some process. |
|
|
Illustrations, diagrams and schematics | A digitally created representation (drawing) of a process. |
|
|
Logos | A digital icon used to represent a product or project. |
|
|
Posters | A combination of images and text used to promote/explain a work product. | ||
Charts, graphs and tables |
A diagrammatic representation of data. |
Videos
editInclude a translatable transcript and a descriptive caption for the video.
Type | Description | Usage tips | Example |
---|---|---|---|
Screencasts | Recording of a computer screen display. |
|
|
Talk recordings | Recording of a live talk, tutorial or workshop. |
|
|
Animations | Digitally created moving pictures. |
|