Getting better at technical writing

Getting better at technical writing

Why technical writing?

The purpose of technical writing is knowledge transfer.
We usually come across technical writing in journals or user manuals. The purpose of technical writing is to communicate complex information to a diverse audience, facilitating knowledge transfer and enabling informed decision-making.
Technical writing serves as a bridge between subject matter experts and users, providing clear and concise documentation that is accessible and understandable to all. This requires a deep understanding of the subject matter, and the ability to translate technical jargon into plain language.

How is technical writing different from business writing?

Technical writing focuses on communicating technical concepts and information, but business writing is more persuasive, and sales-oriented. As technical writing continues to evolve, embracing new technologies and adapting to changing communication patterns become essential for effective communication in various industries.

The basics of writing skills include research and accuracy, clarity, and persuasiveness. These, like other skills, are something you can get better with, with time and practice.
Here are some tips:

1. Read the kind of writing that you eventually want to write.

Having an idea of what the finished writing can look like can guide your writing. Read good samples of the kind of writing you’re interested in, like articles and reports. Making reading a part of your life will also improve your writing.

2. Proof-read 

It’s important to re-read what you’ve written. Here are some tips:

Set aside your work before you edit: Step aside a bit because then you can get back to it with a more objective point of view. If you’re short of time, allot 20 minutes between writing and proofreading.

3. Start with easy fixes. Then progress to bigger changes. As you re-read your piece of work, make small changes in spelling and grammar. By then you get into the rhythm of that proofreading. Then you work on the bigger parts like structure and transition.

4. Fewer words: If you can say something in fewer words, do it. Being wordy can take away the clarity for the reader. Avoid repetitive phrases.

5. Form an outline that will help fix the structure: The outline will help you clarify what you hope toconvey in each section – which will help you visualise the flow of your piece. The structure will bedifferent depending on what you’re writing. An essay typically has an introduction, body paragraphs, and a conclusion.

6. Some common fixes:

  •  Avoid passive voice
  •  Cut unnecessary words
  •  Replace cliches with original phrasing

Whether you’re a scientist or an IT professional, writing effectively will help you communicate your ideas to the world.

 

Write, so that you can say exactly what you want through practice, exposure, and familiarising yourself with basic rules!

#Communications coach

#Science Communication coach

#Public Speaking Coach

#Communication Coach for IT and Science & Tech Professionals

#Communication Coach for IT Professionals