Referencing Screen shots in technical/knowledge base articles?
when writing knowledge base articles to support software users - is it ok to reference the screenshots I am using with the term "Figure"? For example, using '(See figure 1)' in the body text when figure 1 is a screen shot on page? Are there other terms/standards that should be used?
This post was sourced from https://writers.stackexchange.com/q/30361. It is licensed under CC BY-SA 3.0.
2 answers
You are accessing this answer with a direct link, so it's being shown above all other answers regardless of its score. You can return to the normal view.
"See figure x" or "Figure x" is the usual way of doing it, or just "(fig.x)". It's perfectly fine as long as the captions on the figures match the references in the text.
If the screenshots are of your own software this is a nice way of doing it, but watch out for third party software that might change or differences in the way different operating systems display things.
(Users' manuals displaying recognisable W98 windows looked old very quickly.)
Online, you might have the option of a hyperlink, too.
This post was sourced from https://writers.stackexchange.com/a/30376. It is licensed under CC BY-SA 3.0.
0 comment threads
There are three basic reasons for using figure references in a document, rather than just putting the figures inline in the text next to the point where they are referenced:
You are referencing a figure from more than one place in your document. Using figure references lets you insert a reference to the figure each time it is mentioned, rather than having to place it inline each time you talk about it.
You are printing the document and you want to optimize pagination by moving the figure away from the text that mentions it and putting it on a new page, allowing the text to flow more evenly and avoiding big gaps at the top of bottom of pages. Using figure reference allows you to move the figure referred to on page 23 to page 24 to make the pages flow better. Many automated authoring systems will move the figure to the nearest large enough space automatically if you use the right markup.
You have use figure references elsewhere in the document or in other documents and you want to maintain a uniform look and feel throughout the whole documentation set.
If these conditions don't apply (as they may not if most of your material is presented online rather than on paper) then the use of figure references may just be unnecessary clutter.
0 comment threads
0 comment threads