«Здравствуйте, Я Технический Писатель»

Мы все любим читать документацию.

Ну, возможно, не все.

Есть люди, которые сначала экспериментируют с каким-то устройством, доводят его до «почти сломанного» состояния и только потом начинают читать описание его работы.

А некоторые даже не прикоснутся к нему, не прочитав все бумаги в коробке от корки до корки.

Но все согласны с тем, что документация важна и необходима.

Даже для предметов, у которых есть только одна или две кнопки.

(Вы знаете, как перенести картинку с экрана на «пленку встроенной камеры» на айфоне? Прочтите документацию.

RTFM, иначе говоря, там все описано).

Кто пишет такие описания? Программисты? Вы ошиблись.

Как я где-то читал, хорошо, если программист может написать что-то лучше, чем «Я много работаю».

Это работа, не связанная с программированием; Хорошо, если они сами комментируют свой код. Есть такая должность - технический писатель.

Кстати, позиция очень важная.

Ведь в западных странах потребители очень хорошо знают свои права.

А если что-то не описано в документации и из-за этого происходят неординарные действия (кто знал, что он взорвется, если не нажать все три кнопки одновременно!!!), то у потребителя есть шанс перейти к суд с иском на значительную сумму и большими шансами его выиграть.

Вы понимаете, что после проигранного судебного разбирательства в компании начнется внутреннее расследование, результаты которого могут оказаться плачевными для тех, кто его проглядел.

В постсоветских странах люди меньше осведомлены о своих правах, а производители часто считают, что наши люди очень умные — зачем все объяснять.

Кто он, «технический писатель»? Вот что говорит Википедия: “ Технический писатель — профессиональный писатель, который разрабатывает, пишет, обновляет и корректирует техническую документацию, включая онлайн-справку, руководства пользователя, официальные документы и другие типы документов».

Технический писатель может разрабатывать документацию не только для программных продуктов (как может показаться), но и для других потребительских продуктов и даже редактировать результаты работы инженеров и ученых для печати или презентаций.

Вот такой он – с виду незаметный, но чрезвычайно важный член команды.

Ну вот и все на сегодня.

В нашем следующем посте мы расскажем, чем занимается технический писатель и что и сколько он получает взамен.

Теги: #техническая литература #технический писатель #документация #Подготовка технической документации

Вместе с данным постом часто просматривают:

Автор Статьи


Зарегистрирован: 2019-12-10 15:07:06
Баллов опыта: 0
Всего постов на сайте: 0
Всего комментарий на сайте: 0
Dima Manisha

Dima Manisha

Эксперт Wmlog. Профессиональный веб-мастер, SEO-специалист, дизайнер, маркетолог и интернет-предприниматель.