September 17, 2009 at 23:44"Hello, I am a technical writer."
We all love to read the documentation. Well, maybe not all. There are people who first experiment with some kind of device, bring it to a state of “almost broken,” and only then take up reading the description of its work. And some will not even touch him without having read all the pieces of paper in the box from cover to cover. But everyone agrees that the documentation is important and necessary. Even for items on which only one or two buttons. (But do you know how to transfer the picture on the screen to the “camera film on iPhone” on the iPhone? 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’s good if the programmer can write something better, “I’ve gone all round.” 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 well. And if something is not described in the documentation and because of this extraordinary actions occur (who knew that it would break if you didn’t press all three buttons at the same time !!!), then the consumer has a chance to go to court with a lawsuit considerable amount and great chances to win it. You understand, after a lost court, the company will begin an internal investigation and the results can be disastrous for those who overlooked. In post-Soviet countries, even people know their rights worse, and manufacturers often think that our people are very smart - why explain everything.
Who is he a “technical writer”?
Here's what Wikipedia writes:
“ Technical writer“This 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 documentation for software products (as he can seem), but also to other consumer goods and even edit the results of labor of engineers and scientists for printing or presentations.
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 receives in return.
Who writes such descriptions? Programmers? You did not guess. As I read somewhere - it’s good if the programmer can write something better, “I’ve gone all round.” 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 well. And if something is not described in the documentation and because of this extraordinary actions occur (who knew that it would break if you didn’t press all three buttons at the same time !!!), then the consumer has a chance to go to court with a lawsuit considerable amount and great chances to win it. You understand, after a lost court, the company will begin an internal investigation and the results can be disastrous for those who overlooked. In post-Soviet countries, even people know their rights worse, and manufacturers often think that our people are very smart - why explain everything.
Who is he a “technical writer”?
Here's what Wikipedia writes:
“ Technical writer“This 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 documentation for software products (as he can seem), but also to other consumer goods and even edit the results of labor of engineers and scientists for printing or presentations.
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 receives in return.