The world of technical writing

I was curious about what technical writing is, so I’ve been reading up on it. It seems like an interesting activity, less known than its creative equivalent and with projection in an increasingly technological reality.

Drawing of a sheet with something written on it and whose title is USER GUIDE, to symbolize the work of a technical writer

Technical writing is one of the main ways of technical communication. This consists of exposing a topic (any) in a formal way (coherent, following the rules), objective (supported), precise (accurately, without ambiguities or errors), clear (easy to understand), legible (accessible, findable) and at to be concise (brief) from a specific perspective (an approach) with a practical purpose (not knowledge).

Very briefly, we could affirm that the textual style of technical writing is characterized by short and direct sentences.

In the same way that there is commercial writing, in the professional and academic environment people of different profiles and sectors write technical texts as one of their work tasks. However, there is a specialized profile that is dedicated to preparing these documents as its main task: the technical writer.

The function of a technical writer is to start from the knowledge of the experts, often complex, to create texts with which specific readers (of their client) understand a process or idea in a pleasant way and with the minimum of effort. You have to find out what the recipient knows to determine the information, its hierarchy and navigation, as well as what the reader of the document expects to achieve.

Let us consider that this communication can be internal (to employees) or external (to clients, users, patients). And that the audience can be homogeneous or diverse, specialized or not.

Technical writing is usually related to writing about the assembly or operation of devices or programs, however, it is also used in other fields such as business and finance or health and environmental sciences.

The order can be technical documentation such as instructions or repair manuals, but also reports, white papers, bids or proposals (RFP), technical articles, brochures, product descriptions, frequently asked questions (FAQs), technical sheets, templates, presentations, documentation processes (how to adapt to ISO standards) and training modules, among others.

In addition to text, tables or graphs are made, it is transmitted with images or other forms that communicate efficiently.

As an example, one specialized position currently in demand is API writer within software documentation. He writes so that programmers understand how to connect an API to their program or web step by step.

Whoever writes must understand the subject he is talking about and the users, so he will have to document himself, with the files of a company, (beta) testing the product and talking with people from various departments or sectors who may not understand the need for that talk or request.

To master the language in which it is written, there are conventions and books, especially in English, which indicate the style of a technical text and good practices (such as facilitating new versions of content in other languages). Likewise, each company and brand follow standards, normally compiled in a style guide.

For example, some recommendations are to stick to describing the real process (not the theoretical one according to the designers), which structures will be better in each case, how to address the reader, what words should be avoided or rules to respect such as punctuation.

It is not customary to give a lot of time to prepare the content. However, in certain positions a continuous improvement of the texts is sought, such as a help center that changes as customer opinions are read.

As with any creation, there are different drafts and it is advisable to submit the near-final version to test readers.

The technical writer must deal with various computer tools for text editing, images (attention to their rights), screenshots and layout to generate the requested document, as well as web or company systems (CMS, ERP) or languages markup as XML. Some fall into the category of authoring tools. Regarding the development of work, the environment is an office, either in the office or remotely.

Someone commented in this conversation between professionals that three types of knowledge are needed to be a technical writer: 1) understanding what the user needs, 2) being clear about how that reality works and 3) knowing how to express oneself in an understandable way.

Knowing the regulations of the sector will be necessary in certain cases so that the documents comply with the regulations.

In supervisory positions (lead or senior) other skills are required, such as team or budget management

This profession is often reached from various paths (career change). Rather than asking for certifications, those who hire technical communicators seek skills, experience, and verify for themselves with a portfolio and in interviews or sample work.

In any case, for those who want some specific training, there is at least one workshop in English, several specific courses or courses from companies like Google to learn technical writing.

Associations in this field can offer some qualifications, contacts and other useful references. Examples are the (Spanish) Association of Scientific-Technical and Academic Authors (ACTA), the European Association for Technical Communication (Tekom) or, at the North American and global level, the Society for Technical Communication (STC).

On a broader level, there are private courses, from universities or foundations, as well as some careers and master’s degrees to learn how to obtain data (such as Library and Information Science, Journalism), acquire technical knowledge (Engineering, Science…) and write well (Philology, Translation, writing and proofreading).

Collaborating in free or non-profit software projects is a tactic to start gaining experience in this.

As in other professions, there is the option of being a freelance (autonomous) or someone’s employee. In English-speaking countries, the salary of a technical writer per hour or contract is higher than in the Hispanic environment for now, since it is a more established profile.

Places to find opportunities would be LinkedIn, job boards, and the websites of each manufacturing, distribution, or technology company.

Related posts:

I work with teacher training and I was thinking about what it is to be a good teacher? Is there a teacher model to follow? Well, to answer that question we will all look for models of teachers with…

Beberapa pejabat teras Dewan Pimpinan Cabang Perhimpunan Advokat Indonesia (DPC Peradi) Surabaya, berkunjung ke Universitas Muhammadiyah Sidoarjo (Umsida) Pukul 14.00 WIB (26/01/2023). Kunjungan yang…

DevOps monitoring refers to the continuous, automated process of identifying, tracking, analyzing, and reporting on specific components of the entire pipeline.Monitoring DevOps increases development…