69 tips for technical writing
Hey, Guys!
Here, I'm just sharing the 69 tips for improving and enhancing your technical writing skills. These tips can be useful for everyone, including those who don't know technical writing.
- Technical writing is a skill to write technical things for separate audiences.
- Attain better technical knowledge.
- Know the grammar of the writing language.
- Know the 7 C's of Communication.
- Befriend with Five W's and one H.
- Know about the parts of speech, i.e., noun, pronoun, verb, adjective, adverb, conjunction, preposition, and transition, and identify them.
- Know the difference between active and passive voice.
- Use the active voice.
- Use acronyms to make sentences short.
- Use acronyms if they are mostly needed.
- Always define new or unfamiliar terms and words.
- Always stick with the same term throughout the document.
- Don't confuse the readers with the same thing using different words.
- Don't confuse the readers with improper pronoun placement.
- Write in imperative or command style statements.
- Use descriptive verbs like raise, generate, clarify, etc., instead of a blank verbs like occur, happen, say, etc.
- Write data specifically instead of vaguely.
- Do the technical writing, not the marketing.
- Avoid unnecessary adjectives, i.e., cat meowed heavenly into cat meowed.
- Use one sentence to convey one piece of information.
- Stick with short sentences and omit extra words.
- Use lists and tables.
- Use a bullet list for unordered items and a number list for ordered items.
- Making a list with related items or similar structure, called a parallel list.
- Making a list with unrelated items or different structure is called a nonparallel list.
- Prefer the parallel list.
- Capitalize the first word of the list items.
- Punctuate the list items properly if it is a sentence.
- Use a table to simplify the data.
- Give a proper heading for the table columns.
- Never overload the table cell.
- Use parallel tables, i.e., the same data type for a column.
- Format a table that is page responsive.
- Introduce table or list with its description.
- Make a crisp and strong opening sentence.
- Deliver only one topic in one paragraph.
- Write paragraphs in 4 to 6 lines.
- Answer what, why, and how while writing a paragraph.
- Know your audience and write for them.
- Don't teach trigonometry theorem to your baby.
- Don't teach alphabets to a rocket scientist.
- Respect the audience or receivers.
- Don't be rude.
- In other words, be polite in tone.
- Avoid any discrimination or biases.
- Use simple words.
- Consider the audience when using idioms.
- State the scope of the document and audiences.
- Focus on the starting page and give an outline of the document in it.
- Use compare and contrast techniques to write content.
- Use proper punctuation.
- Don't use a comma to write two different main clauses.
- Use the Oxford comma.
- Use a semicolon to connect two highly related thoughts.
- Prefer to avoid en dash.
- Use fewer parentheses and minimize digression.
- Learn about Markdown.
- Draft, edit, review, and repeat.
- Read the document aloud to spot awkward phrases.
- Stick with the style guide.
- Take a break before editing.
- Give it for peer review.
- Prefer to write shorter for a non-technical audience.
- Write a better outline before writing the first draft.
- Maintain proper navigation through the document.
- Avoid immediate jump of h2 to h3 headings by next line.
- Avoid unknown terms in headings and subheadings.
- Add good graphics.
- Utilizes writing assistance tools.
That's it,
:)
love you all,
vino4d
Comments
Post a Comment