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

66%
+2 −0
Q&A In end user documentation, should screenshots come before or after the text that references them?

The end user documentation I'm writing makes use of screenshots (and partial screenshots) to show the user what I'm referring to in procedural instructions or conceptual explanations of the softwar...

2 answers  ·  posted 11y ago by Matthew Rodatus‭  ·  last activity 4y ago by Monica Cellio‭

#3: Attribution notice added by user avatar System‭ · 2019-12-08T02:55:58Z (about 5 years ago)
Source: https://writers.stackexchange.com/q/8164
License name: CC BY-SA 3.0
License URL: https://creativecommons.org/licenses/by-sa/3.0/
#2: Initial revision by user avatar Matthew Rodatus‭ · 2019-12-08T02:55:58Z (about 5 years ago)
The end user documentation I'm writing makes use of screenshots (and partial screenshots) to show the user what I'm referring to in procedural instructions or conceptual explanations of the software.

However, I'm never quite sure whether to put the screenshot before the paragraph that refers to the screenshot or afterward. What is most readable? Furthermore, I'm not using figure captions. So, the problem might be that I have large sections of text referring to the screenshot at all. Maybe the caption should explain the screenshot and the text shouldn't directly refer to it.

What are some practices in technical writing that would help me here?

#1: Imported from external source by user avatar System‭ · 2013-06-14T12:24:00Z (over 11 years ago)
Original score: 14