Communities

Writing
Writing
Codidact Meta
Codidact Meta
The Great Outdoors
The Great Outdoors
Photography & Video
Photography & Video
Scientific Speculation
Scientific Speculation
Cooking
Cooking
Electrical Engineering
Electrical Engineering
Judaism
Judaism
Languages & Linguistics
Languages & Linguistics
Software Development
Software Development
Mathematics
Mathematics
Christianity
Christianity
Code Golf
Code Golf
Music
Music
Physics
Physics
Linux Systems
Linux Systems
Power Users
Power Users
Tabletop RPGs
Tabletop RPGs
Community Proposals
Community Proposals
tag:snake search within a tag
answers:0 unanswered questions
user:xxxx search by author id
score:0.5 posts with 0.5+ score
"snake oil" exact phrase
votes:4 posts with 4+ votes
created:<1w created < 1 week ago
post_type:xxxx type of post
Search help
Notifications
Mark all as read See all your notifications »
Q&A

Post History

60%
+1 −0
Q&A How to reference a figure from text in a technical document

In the absence of a style guide saying otherwise, your approach is fine. (So is abbreviating to "Fig.", though I prefer to spend the extra three letters and use the full word. It's also consisten...

posted 10y ago by Monica Cellio‭  ·  last activity 4y ago by System‭

Answer
#3: Attribution notice added by user avatar System‭ · 2019-12-08T03:21:59Z (over 4 years ago)
Source: https://writers.stackexchange.com/a/10613
License name: CC BY-SA 3.0
License URL: https://creativecommons.org/licenses/by-sa/3.0/
#2: Initial revision by (deleted user) · 2019-12-08T03:21:59Z (over 4 years ago)
In the absence of a style guide saying otherwise, your approach is fine. (So is abbreviating to "Fig.", though I prefer to spend the extra three letters and use the full word. It's also consistent with "Table", which I haven't seen abbreviated as "Tab.".)

Whatever you do, be consistent -- refer to all of your figures as "Figure N" and use that same text in the figure captions.

If the figure isn't immediately adjacent to the text, use a cross-reference. I believe all modern documentation formats support this.

One final thought: if your style permits this, for step-by-step instructions consider dispensing with the figure references. Do the 15 screen shots involved in configuring such-and-such preferences for your product really need to be individually numbered and listed in the table of contents (or table of figures)? Consider instead the following style:

> 1. Select "File -\> Preferences" to open the preferences panel:  
> [screen shot of preferences panel]
> 
> 2. Select the "Advanced" tab:  
> [screen shot of advanced tab]
> 
> 3. Click the "Configure SSL" button to (blah blah blah):

In this style, the screen shots become part of the narrative. This only works if each screen shot is only relevant once, in its immediate context; if you'll need to refer to them from elsewhere in the document, numbering will make that easier.

#1: Imported from external source by user avatar System‭ · 2014-03-26T17:47:31Z (about 10 years ago)
Original score: 3