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

50%
+0 −0
Q&A Formatting of Text in Technical Writing (Procedure Writing)

This is all about recognition. The user may recognize the component being mentioned by name (verbal) or by sight (visual). Recognition by name is sufficient in most cases. If you are going for re...

posted 6y ago by Mark Baker‭  ·  last activity 4y ago by System‭

Answer
#4: Attribution notice removed by user avatar System‭ · 2020-01-03T20:41:56Z (over 4 years ago)
Source: https://writers.stackexchange.com/a/32891
License name: CC BY-SA 3.0
License URL: https://creativecommons.org/licenses/by-sa/3.0/
#3: Attribution notice added by user avatar System‭ · 2019-12-08T07:48:15Z (over 4 years ago)
Source: https://writers.stackexchange.com/a/32891
License name: CC BY-SA 3.0
License URL: https://creativecommons.org/licenses/by-sa/3.0/
#2: Initial revision by user avatar System‭ · 2019-12-08T07:48:15Z (over 4 years ago)
This is all about recognition. The user may recognize the component being mentioned by name (verbal) or by sight (visual). Recognition by name is sufficient in most cases.

If you are going for recognition by name, the the reason for bolding the text in the manual is to offset the name from the rest of the text so that the reader can easily pick out the name. It is not about making the text look like the text in the interface, because you are relying on recognition by name, not appearance.

On the other hand, if you are going for recognition by sight, then you are creating a picture of the control in the documentation and that picture should be an exact match for the control or the visual match will not work. This means that you are going to want to match everything: font, color, style, etc. Often the best way to do this is with a graphic or a photograph of the control rather than by manipulating the font.

There is no point in doing anything between these two, however. If the visual match is not complete than either the reader's visual matching will be confused or they will fall back on verbal matching, in which case the font choice etc is irrelevant.

#1: Imported from external source by user avatar System‭ · 2018-01-31T14:49:56Z (about 6 years ago)
Original score: 8