О бедном техписе замолвите слово

Есть такие люди — технические писатели, они же техписы. Многие о существовании такой профессии даже не подозревают, многие из оставшихся имеют о ней неправильное представление. На самом деле, технический писатель — это специалист, который занимается документированием разного рода технических процессов. Техпис в конструкторском бюро пишет инструкции по монтажу и сводные спецификации, на заводе — технические задания и программу приемных испытаний, в софтверной компании — руководство пользователя и справочную систему. Иногда им доводится писать даже тексты для сайтов и справочную литературу.

Только тут такая вот штука: на технических писателей в наших ВУЗах не учат. Ни в Общероссийском классификаторе специальностей, ни в его украинском аналоге, Классификаторе профессий Украины, такой специальности нет. Тем не менее, технические писатели в природе существуют, это подтверждается свидетельствами очевидцев, а также наличием продуктов их жизнедеятельности — хороших, добротных, профессионально написанных ТЗ, руководств, справочников и других нужных и полезных технических документов. Учиться техписы своему ремеслу вынуждены самостоятельно: по книгам, статьям, изучая специальные сайты, общаясь в форумах. И я хочу подкинуть пару монеток в эту копилку. Ресурсы эти, на самом деле, хорошо известны в профессиональных кругах, но вот новичкам может быть трудно сразу выйти на их след.

«Философт»

Первый ресурс — это сайт компании «Философт». Вроде бы, просто корпоративный сайт, но на деле это один из главных ресурсов на котором собираются технические писатели для обмена опытом. «Философт» занимается разработкой технической документации для программного обеспечения, это их основная специальность.

Сайт компании Философт

На сайте собрана небольшая, но крайне полезная коллекция статей по техническому документированию. Это записи выступлений на конференциях, семинарах, вебинарах, публикации для сетевых ресурсов. Они охватывают гораздо более обширную область, чем необходимо для повседневной работы техпису в веб-студии, но широкий кругозор еще никогда никому не мешал. Для примера несколько статей, которые могут быть интересны всем:

Кроме того, на сайте есть живой и относительно многолюдный форум с очень дружелюбной атмосферой, на котором можно получить профессиональный совет.

«Техническая документация»

Это опять же сайт компании с незатейливым, но красноречивым названием «Техническая документация». Несмотря на не очень удачный дизайн, ресурс крайне полезный. Вот прямо читать от корки до корки. Статьи поделены по разделам, на мой взгляд, не совсем удобно, ну да это дело вкуса. Зато здесь есть и практические советы, и обзорные статьи, и примеры документов, и даже истории из жизни:

А форум тут необитаемый.

Сайт компании Техническая документация

Еще один форум технических писателей

Techwriters.ru/forum — он тоже базируется на сайте компании, которая занимается разработкой технической документации, но сам сайт не может похвастаться богатой сокровищницей статей. Зато форум очень неплох.

Форум технических писателей

ГОСТы — как без них?

Очень хороший сайт RuGost, я его уже рекомендовала в одной из прошлых статей, посвященных разработке технического задания. Здесь есть полный набор стандартов, которые могут понадобиться техническому писателю, примеры и шаблоны документов, оформленных по ГОСТ.

В частности, здесь можно найти и пример ТЗ на разработку сайта.

Сайт RuGost

И на сладкое

Технический писатель, в силу своей работы, часто общается с программистами. Можно сказать, что его задача — наладить взаимопонимание между программистами и пользователями, клиентами и разработчиками, специалистами разных профилей. И поэтому техпис вынужден то и дело вставать то на одну сторону, то на другую, вживаться в противоположные роли, принимать столь разный образ мыслей. На самом деле, это может быть довольно занимательно, а иногда даже забавно. Поэтому в заключение статьи, чтобы закончить ее за мажорной ноте — «Словарь ненормативной лексики программиста», составленный Игорем Ашмановым. Хоть он не технический писатель, но на общении с программистами тоже собаку съел.

Словарь ненормативной лексики программиста