ТрудовыеБудни

Что делает технический писатель? Состав работ технического писателя зависит как от сферы деятельности, в которой работает техпис, так и от наличия в команде других людей, которые тоже занимаются документацией (аналитиков, архитекторов, инженеров, конструкторов и пр.). От сферы деятельности в основном будет зависеть состав документации и те, процессы, которые будут приводить к созданию ее итогового варианта. Даже два технических писателя работая в одной сфере (например, в IT, как я), могут выполнять разный набор работ и заниматься подготовкой разных документов. Эти работы будут зависеть от того, в каком месте процесса (вот может не очень хорошо написала, но по сути – это так), находится технический писатель. Например, если это поддержка пользователей, то там в основном пишутся руководства и инструкции, присутствует локализация документов (если компания большая и документация должна быть на разных языках). Если техпис входит в команду разработки, то в основном он пишет документацию или по ГОСТ, или близко к ГОСТ, или заранее определенный комплект документов, состоящий как правило из документов, описывающих продукт на разном уровне и предназначенный для пользователей разного уровня. При этом многое будет зависеть и от того, как в компании организована работа с разработчиками (описывают ли они что-то по своей части, комментируют ли код, есть ли у них время на консультацию техписа и пр.). Также в последние несколько лет техписы довольно плотно взаимодействуют и с отделом маркетинга. Отсюда вытекает еще ряд требований к документам, например требование вписывать определенные слова в текст. Если такая документация размещается в открытом доступе (на странице сайта), то при необходимости внесения изменений в текст (например, в инструкцию по установке ПО или инструкцию для пользователя), может потребоваться дополнительное согласование с отделом маркетинга. Поэтому, превращая документацию в страницы сайта и ссылаясь на них из других мест, нужно помнить, что многие продукты «растут», развиваются, обрастают новыми функциями, меняют интерфейс и документация не будет статичной, она будет меняться. Есть еще ряд людей, которые тоже являются техническими писателями, но они занимаются тем, что вычитывают документацию, поступившую от подрядчиков. Сами пишут мало, в основном занимаются тем, что сводят поступившие комплекты документации в один, разрабатывают шаблоны документации для новых проектов. Т.е. в разных компаниях круг работ будет в чём-то похож, в чём-то будет очень сильно отличаться. Я постараюсь рассказать о своем опыте работы техническим писателем. Я не претендую на истину в последней инстанции и не говорю, что должно быть вот так и никак иначе, просто рассказываю, оно как может быть.