Post History
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...
#3: Attribution notice added
by
System
·
2019-12-08T02:55:58Z (over 4 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
Matthew Rodatus
·
2019-12-08T02:55:58Z (over 4 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
System
·
2013-06-14T12:24:00Z (almost 11 years ago)
Original score: 14