Formatting of Text in Technical Writing (Procedure Writing)
In a procedure, when describing a UI component, we use the bold font to represent UI components. We also match the text with the letter case of the UI component. But do we need to match the font style too? For example, if the UI component is in italic formatting, do we need to write the text in italic characters?
This post was sourced from https://writers.stackexchange.com/q/32884. 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.
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.
0 comment threads
These are style questions and mostly a matter of opinion; but if the matching is intended to help the user recognize the key, then if I were writing a manual I would match the italics, and if possible the font as well.
I presume by "procedure" you do not mean code, but a recipe of action for a human operator to accomplish some goal or outcome.
0 comment threads
0 comment threads