📜 ⬆️ ⬇️

"Hello, I am a technical writer"

We all love to read documentation. Well, maybe not all. There are people who first experiment with some device, bring it to the state of "almost broken" and only then take up the reading of the description of his work. And some will not even touch it without reading all the pieces of paper in the box from cover to cover. But everyone agrees that documentation is important and necessary. Even for items on which only one or two buttons. (and here you know, like on the iPhone, the picture that is on the screen, transfer to “the film of the built-in camera”? Read the documentation. RTFM, in other words, everything is described there).

Who writes such descriptions? Programmers? You did not guess. As I read somewhere, it is good if a programmer can write something better “I am pashol after pyvv”. Non-programmer is work; Well, if they comment on their code.

There is such a position - a technical writer. By the way, the position is very important. Indeed, in Western countries, their consumers know their rights oh how good. And if something is not described in the documentation and because of this, freelance actions occur (who knew that it would jerk if not all three buttons were pressed simultaneously !!!), then the consumer has a chance to go to court with a lawsuit against A considerable amount and a great chance to win it. You understand that after a lost court, the company will begin an internal investigation and the results can be deplorable for the short-sighted. In the post-Soviet countries and people know their rights worse, and manufacturers often believe that our people are very smart - why explain everything.

Who is he - “technical writer”?
')
Here is what Wikipedia writes:

“A technical writer is a professional writer who designs, writes, updates, and corrects technical documentation, including online help, user manuals, official white papers, and other types of documents.”

A technical writer can develop not only software documentation (as it may seem), but also other consumer products and even edit for printing or presentations the results of the work of engineers and scientists.

Here he is - seemingly inconspicuous, but extremely important member of the team.

Well, that's all for today. In our next post we will tell you what a technical writer does and what and how much he gets in return.

Source: https://habr.com/ru/post/69981/


All Articles