: 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

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?

Load Full (2)

: Q about verb tenses for technical writing This kind of thing comes up a lot in my engineering job. We're writing a document that is a Plan for something we'll be doing in the future. For

@Shelton455

Load Full 1 Comments

: Are there any free sites for testing beta 'book cover' designs? The LONG road to publishing a novel is nearing an end. But writing a novel is actually only the beginning; editing, formatting,

@Shelton455

Load Full 2 Comments

: Is it a good idea to make the protagonist unlikable while making the supporting characters more likable? My protagonist is a very shitty person that makes bad decisions for the wrong reasons.

@Shelton455

Load Full 3 Comments

: How do you make the reader root for the protagonist when the primary antagonist is more relatable and more likable? I said in a previous question that my protagonist "is a very shitty person

@Shelton455

Load Full 3 Comments

Login to post a comment!

2 Comments

Sorted by latest first Latest Oldest Best

@XinRu607

Typically in documentation you would want every UI reference to be styled consistently. This would lead me to think that matching font styles to individual elements is not the ideal approach.

Best practice would be to create a style guide that includes how you are going to indicate a UI element, and adhere to that in all cases. This will help your audience recognize a UI element when they see one in the text.

Load Full (0)

@Holmes449

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.

Load Full (0)

Feed

: 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

More posts by @Shelton455

: Q about verb tenses for technical writing This kind of thing comes up a lot in my engineering job. We're writing a document that is a Plan for something we'll be doing in the future. For

: Are there any free sites for testing beta 'book cover' designs? The LONG road to publishing a novel is nearing an end. But writing a novel is actually only the beginning; editing, formatting,

: Is it a good idea to make the protagonist unlikable while making the supporting characters more likable? My protagonist is a very shitty person that makes bad decisions for the wrong reasons.

: How do you make the reader root for the protagonist when the primary antagonist is more relatable and more likable? I said in a previous question that my protagonist "is a very shitty person

Login to post a comment!

2 Comments

Back to top