Another way to make your technical manual consistent in language is to be consistent with terminology and formatting. This means that you should use the same terms and expressions throughout your document to refer to the same concepts, features, or functions. You should also use the same formatting conventions for elements such as code blocks, keyboard shortcuts, menu items, buttons, icons, labels, and messages. For example, if you use the term "widget" to refer to a component of your product, you should not switch to "gadget" or "module" in another section. Similarly, if you use
tags to format code blocks, you should not use quotation marks or italics in another section.
###### Avoid personal pronouns and opinions
A technical manual is not a place to express your personal opinions, feelings, or preferences. It is a place to provide objective, factual, and reliable information that helps the reader achieve a specific goal or solve a problem. Therefore, you should avoid using personal pronouns such as "I", "we", "you", or "your" in your technical manual, unless they are necessary for clarity or instruction. You should also avoid using words or phrases that imply your opinion, such as "obviously", "fortunately", "unfortunately", "easily", "best", or "worst". Instead, you should use neutral and precise language that conveys the facts and the logic behind your statements.
###### Proofread and edit your document
The final step to make your technical manual consistent in language and tone is to proofread and edit your document. This means that you should check your document for any errors, inconsistencies, or gaps in content, structure, or style. You should also revise your document for any improvements in clarity, readability, or usability. You can use tools such as grammar checkers, spell checkers, or readability analyzers to help you with this process, but you should also rely on your own judgment and knowledge. You may also want to ask someone else to review your document and give you feedback, especially if they belong to your target audience or have expertise in your field.
######Here’s what else to consider
This is a space to share examples, stories, or insights that don’t fit into any of the previous sections. What else would you like to add?