When presenting information it is an utmost priority to do so in a clear, concise way. By doing so, the information will be easy to understand and present little to no difficulties for someone who does not have knowledge in that field to grasp what is being presented.
Abbreviations #
With abbreviations it is important to note the following:
1. Don’t use internal abbreviations on information that is for everyone.
2. Don’t use abbreviations to represent emotions or ideas.
3. Don’t use abbreviations like i.e. and e.g – not everyone knows them.
4. Don’t be vague when presenting an object/product.
Don’t Use: i.e., LMFAO, GTFO, Dev., it is
Do Use: for example, laughing, leave, Developer, the service is
Bold #
With using bolden words, it is typically used for the following reasons:
1. Instructions – Click on Developer > Answers
2. Buttons – Bring attention to the button and the outcome of interacting
3. Headers – Draw the client’s eyes to read this, allows for interaction
Under the circumstance there is an inability to use bold on the product you are working on, the best next resort would be to use italics in place of the bolden words. Although there won’t be as much attention-grabbing from these italicized words, it will still do better than plain text.
Capitalization #
The usage of capitalization is typically due to present a product title or header.
Don’t Do: This Is What Lectron Cosmic Guard Is
Extreme Don’t Do: tHiS iS wHaT LeCtRoN CoSmIc GuArD iS
Do: This is what Lectron Cosmic Guard is.
Gender – Inclusivity #
In order to make everyone feel welcomed, it is important to avoid using any type of pronouns. Under the circumstance you have no other choice but to use a pronoun, you should use “they” and “their”.
Preferred: Ask your Sales Representative to calculate the total.
Okay: Ask your Sales Representative if they can calculate the total.
Don’t Do: Ask your Sales Representative if he can calculate the total.
Bulleted Lists #
When creating a list which does not have importance in the order of which they are ready, it is recommended to use a bulleted list. This allows for clear reading of the information being presented.
Under the circumstance that the list is going to be more than five bullet points long, you can create a second list by formulating multiple categories like seen below;
Main Header
Category 1
– Bullet 1 Here
– Bullet 2 Here
– Bullet 3 Here
Category 2
– Bullet 1 Here
– Bullet 2 Here
– Bullet 3 Here
Numbered Lists #
When creating a list that requires the steps or information to be followed in the exact order that it is presented, it is recommended to use a numbered list. This allows for orderly reading of the information in the order it was presented.
Under the circumstance that the list is going to be more than five bullet points long, you can create a second list by breaking down the steps into specific categories. This is similar to the way in which a bulleted list is broken down.
