Technical Writing

Technical writing has been with us since complex solutions have been created to solve problems. As such, some of these solutions (which are complex) cannot be understood by the general public (average user) as the “solutionists” would like them to be. Hence, the need to explain how these solutions can be utilized properly and correctly in other to achieve the expected outcomes.

Therefore, technical writing is the process and art of tailoring and concisely documenting technical information for the appropriate audience (the audience could be engineers, average users, developers, etc.).

Technical Writer

A Technical Writer, is an individual who seeks to carry out technical writing, that is, make complex solutions a lot easier for the intended users or readers to understand and use.

For example, the instructional document that came with your mobile phone pack or washing machine pack, containing clear directives on how to use them (to solve the problem of washing and making calls, etc.), is technical writing, and the individual who ‘conjured’ this documentation is a technical writer. These documentations can come in form of journal articles, product descriptions, reports, etc.

Skills needed as a Technical Writer

In other to be a technical writer, you need to be able to make complex and technical jargons become easy to understand for the average user or reader, and in other to do this, you must possess certain skills (apart from writing). Some of these skills are:

a. Technical skills:

This refers to knowledge of the subject matter, and understanding of the nature of the choice of topic. There’s a saying that “your understanding of a concept is quantified by how you can explain to the understanding of a three-year-old”, another saying goes “It is when you know the area perfectly that you’re able to give correct directions”. Understanding a subject matter and its technicalities makes it easier to break it down and write to the understanding of the intended audience.

b. Research skills:

Technical writing requires an extensive research ability for finding appropriate user personas through audience analysis and user experience. This skill is used for a clear understanding of the parameters, Dos, and Don’ts of the subject matter, to write effective and valuable documentation.

c. Communication skills:

Communication skills focus more on the clear and concise delivery of useful information to the intended readers. This means that you have to have a clear understanding of your audiences (readers or users) in other to write what is useful for them.

d. Editing skills:

This is a practical skill. It is the ability needed to critically and consistently review and improve upon your drafts, in other to enhance your writing for your desired audience (unclear and clumsy written documentation is useless). You have to be good at proofreading, reviewing, spelling and punctuation, structure, and tone of voice.

e. Tool skills:

A carpenter has his/her toolbox, and so is for a technical writer. For a technical writer, this toolbox has sections:

i. Publishing tools – Hashnode, document360

ii. Spell check tools – Grammarly, ProWriting Aid

iii. Authoring tools – Ms Word, Google Docs

iv. Image editing tools – Canva, Adobe Photoshop, Pixlr

f. Teamwork:

Technical writers usually work with employees from all departments and large target audiences. As a technical writer, you must know how to build your team as well as work and collaborate with everyone on your team irrespective of the difference in backgrounds and areas of knowledge.

Values of a Technical Writer

Every field of work has its values. Values that every individual needs to manifest in other to be called or identified as one of them. These values differentiate you and your field of work from others. Some of them are:

a. Dedication

Commitment, consistency, and drive are all forms of dedication in technical writing. This will allow you to always look to improve your writing and knowledge no matter the obstacles you face.

b. Patience

You need to understand early that real growth takes time, and you have to be prepared and patient to accumulate and learn from your failures and your success. You learn every day in technical writing, so don’t be discouraged when you publish your articles or documentation and it has a negative return, there is always room for growth, and even the best writers today started from where you are now.

c. Professionalism

It is about embracing and showcasing the values of technical writers. Professionalism cuts across several work fields (it is in technical writing as well). You need to be of good conduct as a writer, in terms of treating your clients and end users with utmost respect and consideration in carrying out your duty as a professional technical writer.

d. Constant development and growth

The willingness to adapt and grow at whatever pace you can is an important value that you must possess as a technical writer. This occurs as a result of learning from mistakes and taking note of corrections to work on them. Learning is a constant concept; a technical writer must be able to move with this, which in turn translates to growth and development.

NB: Finally, don’t forget to frequently spend time away from your work and your computer. Spend time with your friends and family and most importantly yourself. That is the best advice you can get from anywhere.