Acronym Usage Guidelines
Proper use of Acronyms: Spell out full term and put acronym in parentheses before using the acronym.
Example:
We were using a Virtual Private Network(VPN) to access twitter in my country. Then, the president chose to ban the use of any VPN.
Make use of acronyms when it may appear multiple times throughout the document and is significantly shorter. Readers need high familiarity with the term before shortening it becomes useful.
Pronouns Usage Guidelines
Pronouns should be avoided where they might cause ambiguity. Consider the following pronoun guidelines:
- A noun and it's pronoun shouldn't be more than 5 words apart.
- Two nouns shouldn't appear before a pronoun.
- A pronoun must be used after the noun and never before.
Terms Usage Guidelines
Multiple Terms: Add a glossary of terms when there are multiple unfamiliar terms.
Explain: If it's a new term, make sure to explain it else, link to an explanation of the term.
Explain: If it's a new term, make sure to explain it else, link to an explanation of the term.
Consistency: Don’t rename terms halfway through a document.
Lengthy names: You can specify a shortened name for later reuse e.g.
Protocol Buffers (or protobufs for short) provide their own definition language. Blah, blah, blah. And that's why protobufs have won so many county fairs.
Â
Made with Bullet