Здравствуйте, в этой статье мы постараемся ответить на вопрос: «Кто такой технический писатель: обязанности, обучение и особенности профессии». Если у Вас нет времени на чтение или статья не полностью решает Вашу проблему, можете получить онлайн консультацию квалифицированного юриста в форме ниже.
Ответ на вопрос не будет однозначным. С одной стороны, профессиональное образование в этом деле не помешает. Мест, где учиться, достаточно. Самый “официальный” вуз – это, конечно, московский Литературный институт им. А. М. Горького.
Что делают технические писатели и чем занимаются?
Обязанности на примере одной из вакансий:
- разработка технической эксплуатационной документации и конструкторской документации на существующую и новую продукцию компании (ТУ, ТО, руководства по эксплуатации, паспорта, формуляры, чертежи, схемы и пр.);
- подготовка документации в соответствии с требованиями ЕСКД, проверка КД на соответствие требованиям ЕСКД;
- анализ требований проекта, требований ТЗ;
- разработка/доработка ТЗ;
- согласование технических решений с представителями разных подразделений компании, с заказчиком.
Что нужно знать? Инструменты технического писателя
Набор инструментов технического писателя будет отличаться в зависимости от его задач.
- Язык
Высокий уровень английского, если пишете для международного рынка, чёткость изложения, способность писать доходчиво и стилистически правильно. Английский пригодится, даже если писать вы будете на русском, чтобы общаться с коллегами и контролировать качество перевода.
Обращайтесь к руководствам по стилю (о них расскажем чуть ниже), учитесь писать лаконично и понятно для аудитории текста. Например, если текст для новичков, избегайте сложных терминов.
- Копирайтерские навыки
Вам пригодятся навыки определения целевой аудитории и написания текстов с учётом особенностей ЦА, понимание пользы и болей читателя.
Как и для любого текста, нужно уметь собирать и структурировать информацию, писать и оформлять текст так, чтобы его удобно было читать. Так же, как и любой коммерческий текст, техническая документация решает бизнес-задачу. Например, цель руководства пользователя — снизить нагрузку на отдел техподдержки.
- Технические знания
Должностные обязанности технического писателя во многом зависят от того, чем занимается работодатель. К основным обязанностям относятся:
- Разработка технической документации (руководств пользователя и администратора, правил эксплуатации, ТУ, ТЗ, технических паспортов и прочих документов) в соответствии с требованиями ГОСТ и другими стандартами.
- Проверка и корректировка технической документации, поддержание ее в актуальном состоянии.
- Подготовка графических схем по заданным параметрам.
- Анализ новых программных продуктов и их тестирование.
- Сбор информации у всех участников процесса: заказчиков, разработчиков, дизайнеров, тестировщиков и менеджеров.
Также должность технического писателя может включать в себя дополнительные функции:
- Подготовка материалов технических презентаций.
- Обучение работе в новых программных продуктах и поддержка пользователей.
- Участие во внедрении программных продуктов.
- Составление документации на английском языке.
Здесь мы не будем упоминать атавизмы типа «принести чай» и «настроить принтер», а рассмотрим типовые задачи, с которыми работают техписы.
Нужно ли писателю специальное образование
Филфаки педагогических и гуманитарных университетов рады растолковать своим студентам премудрости словесного творчества. И замечательно, если властителями дум станут люди, разбирающиеся в законах жанра. Но вот совсем не обязательно выпускники вышеназванных вузов ими станут.
С другой стороны, в большой литературе велик процент “самоучек”. У А. П. Чехова было медицинское образование, Г. Г. Маркес по настоянию родителей учился на юриста, И. А. Гончаров окончил коммерческое училище. И ничто не помешало подлинным талантам пробиться в большую литературу.
Поэтому молодой человек, ступающий на литературную стезю, должен четко осознавать, что здесь, как нигде, получение специальности не гарантирует ни практического ее применения, ни творческого успеха. И на случай “утраченных иллюзий” не помешает запасная профессия.
Плюсы и минусы профессии технического писателя
| Плюсы: | Минусы: |
|
|
Написание руководств и инструкций – основная часть работы. А какие руководства бывают?
— Руководство пользователя
– руководство для рядовых пользователей. Описывается всё просто и понятно. Главное – функциональность, описания настроек может не быть.
— Руководство администратора
– документ для тех, кто ковыряется на уровне администратора в крупных комплексах. Пишется только для крупных систем, требующих специалиста, который будет контролировать их.
— Руководство разработчика
– это описание кода, баз данных, элементной базы и физических принципов. Делается для обучения новых сотрудников, чтобы организовать преемственность в коллективе и устранить проблему незаменимости, когда от конкретного специалиста зависит, по сути, вся компания, так как полностью разобраться в коде без него будет практически невозможно.
Мы пишем документацию в формате DITA. Это формат, основанный на XML, который позволяет сохранять исходный текст документов в структурированном виде. Мы пишем исходники документации в этом формате, для этого у нас есть редактор oXygen XML Author. Затем из этих исходников мы можем собрать итоговый документ в любом нужном формате. Для этого есть специальный Toolkit, содержащий XSLT-преобразования. Наш Toolkit позволяет собирать документы во множестве форматов. Самый востребованный — это PDF, иногда собираем CHM или HTML. При желании мы можем собрать даже EPUB, если заказчик вдруг захочет почитать нашу документацию перед сном на электронной книге. По необходимости мы вносим правки в XSLT-преобразования, чтобы изменить правила сборки документов и их внешний вид.
Какими качествами должен обладать
Не важно, собираетесь вы творить только для души или нацелены на заработок. Для работы нужны следующие качества:
- Развитая речь. Написанное скудным языком читать никто не будет.
- Наблюдательность. Видеть невидимое, замечать незамеченное, находить оригинальное в обыденном – без этого не обойтись.
- Развитое воображение. Даже если вы списываете персонажа с лучшего друга, для реализации замысла ему порой нужно придать новые черты и поместить в небывалые обстоятельства. Творцам фэнтези и вовсе без фантазии не прожить.
- Богатый внутренний мир. Часто связан с двумя первыми пунктами. Помогает представлять переживания и чувства героев.
- Настойчивость. Магомет должен не просто идти к горе, а искать все способы подняться на вершину.
- Перфекционизм. Только непрерывное стремление к совершенству поможет стать им. Хотя бы в глазах других.
- Трудолюбие. Без правок создать шедевр почти невозможно.
К данной природой личным качествам необходимо добавить профессиональные:
- Грамотность. Не поспоришь.
- Умение добывать информацию. Порой писатель, как и журналист, общается с десятками людей или исследует не один письменный источник, чтобы сотворить свое произведение. Именно так работал А. С. Пушкин над “Капитанской дочкой”. Сегодня таким образом пишут не только исторические романы, но и многочисленные воспоминания, биографии, различного рода советы (из серии “Как похудеть” или “Как заработать”).
- Организованность. Свое рабочее время планировали Пушкин, Толстой и другие профессиональные писатели. У них не было телевизора и соцсетей, но существовали служебные и семейные обязанности.
- Способность налаживать деловые контакты. Мало быть гением – надо еще и доказать это миру. Рекламировать себя издательствам и читателям, чтобы иметь коммерческий успех (кого коробят эти слова, читайте – “доход”). Не хотите “прогибаться под изменчивый мир” – публикуйтесь на Прозе.ру, в собственном блоге или на сайте. Но в таком случае писательство будет уже не профессией, а хобби.
Написание руководств и инструкций – основная часть работы. А какие руководства бывают?
— Руководство пользователя
– руководство для рядовых пользователей. Описывается всё просто и понятно. Главное – функциональность, описания настроек может не быть.
— Руководство администратора
– документ для тех, кто ковыряется на уровне администратора в крупных комплексах. Пишется только для крупных систем, требующих специалиста, который будет контролировать их.
— Руководство разработчика
– это описание кода, баз данных, элементной базы и физических принципов. Делается для обучения новых сотрудников, чтобы организовать преемственность в коллективе и устранить проблему незаменимости, когда от конкретного специалиста зависит, по сути, вся компания, так как полностью разобраться в коде без него будет практически невозможно.
На поверку становись!
Когда писатель завершает работу над документом, он обязательно отправляет его на проверку. Документацию проверяют бизнес-аналитики, разработчики, тестировщики. Это очень важный этап, ведь писатель всегда может ошибиться — что-то неправильно понять, не учесть каких-то незадокументированных особенностей реализации.
Ещё наши документы проверяет наш профессиональный технический редактор. Он исправляет орфографические и грамматические ошибки, подчищает описки, следит за смысловой и логической чистотой документа, проверяет соблюдение руководства по стилю. Это руководство — наш маленький внутренний стандарт. В нём записаны разрешённые и запрещённые термины, правила оформления документов разных типов, приведены наиболее часто используемые фразы, конструкции и обороты. Руководство по стилю помогает нам писать документацию по общим для всех писателей правилам: единство стиля — прежде всего. В воображении читателя должен возникнуть собирательный образ одного крутого профессионала — писателя, который создаёт разные документы или разделы.
Что нужно знать о российских и зарубежных стандартах
Оформление технической документации должно производиться в соответствии с требованиями стандартов. В российской IT отрасли они следующие:
- ГОСТ 19 (ЕСПД) — для описания программного обеспечения.
- ГОСТ 34 (КСАС) — для документирования автоматизированных систем.
- ГОСТ 2 (ЕСКД).
Стандарты выполняют функцию формализации документов и фиксируют нормативные обязательства участников разработки. Отечественные стандарты применяют при разработках ПО для внутреннего применения.
При заказах, связанных с международным сотрудничеством, применяют современные международные стандарты, касающиеся жизненных циклов программ и систем и их документирования (ISO, IEEE). Это «динамичные» стандарты, которые регламентируют основные процессы жизненных циклов программного обеспечения:
- приобретение;
- поставка;
- разработка;
- функционирование;
- сопровождение.
Они описывают модель жизненного цикла, ее архитектуру, но не прописывают конкретные детали и форматы. Динамичные стандарты дают всесторонний охват проекта, развивающегося во времени.
Технический писатель должен:
- хорошо разбираться в своей профессиональной области;
- свободно владеть языком, на котором готовит документацию, составлять тексты без орфографических, пунктуационных и стилистических ошибок;
- иметь представление о программировании, вычислительной технике, информационных продуктах;
- быть в курсе, чем занимаются коллеги смежных специальностей;
- владеть компьютером на уровне уверенного пользователя, знать специальные программы по редактированию текста, верстке и web-дизайну;
- уметь в короткие сроки осваивать новые компьютерные программы и их обновления;
- владеть техническим английским языком;
- иметь навыки самоорганизации и планирования работы.
Рассмотрим, какими навыками и чертами характера должен обладать технический писатель. Конечно, точный список сильно зависит от компании и рода её деятельности. Разберём на примерах и отметим основные моменты, которые дадут понимание, в каком направлении двигаться.
Представь ситуацию: в офисе крупной IT-компании разработали новый веб-сервис. Возможна ситуация, когда проект развивают и поддерживают не те люди, которые его разрабатывали. В таком случае, грамотная документация очень облегчает жизнь, ведь не требуется изучать проект методом «тыка».
Поэтому отдел разработки приглашает технического писателя, чтобы обсудить работу над документацией. Подобных обсуждений может быть много. Причём, часто по инициативе писателя, ведь в процессе работы всегда находятся спорные вещи, которые требуется уточнить.
Должностные обязанности технического писателя во многом зависят от того, чем занимается работодатель. К основным обязанностям относятся:
- Разработка технической документации (руководств пользователя и администратора, правил эксплуатации, ТУ, ТЗ, технических паспортов и прочих документов) в соответствии с требованиями ГОСТ и другими стандартами.
- Проверка и корректировка технической документации, поддержание ее в актуальном состоянии.
- Подготовка графических схем по заданным параметрам.
- Анализ новых программных продуктов и их тестирование.
- Сбор информации у всех участников процесса: заказчиков, разработчиков, дизайнеров, тестировщиков и менеджеров.
Также должность технического писателя может включать в себя дополнительные функции:
- Подготовка материалов технических презентаций.
- Обучение работе в новых программных продуктах и поддержка пользователей.
- Участие во внедрении программных продуктов.
- Составление документации на английском языке.
Здесь мы не будем упоминать атавизмы типа «принести чай» и «настроить принтер», а рассмотрим типовые задачи, с которыми работают техписы.
Технический писатель должен:
- хорошо разбираться в своей профессиональной области;
- свободно владеть языком, на котором готовит документацию, составлять тексты без орфографических, пунктуационных и стилистических ошибок;
- иметь представление о программировании, вычислительной технике, информационных продуктах;
- быть в курсе, чем занимаются коллеги смежных специальностей;
- владеть компьютером на уровне уверенного пользователя, знать специальные программы по редактированию текста, верстке и web-дизайну;
- уметь в короткие сроки осваивать новые компьютерные программы и их обновления;
- владеть техническим английским языком;
- иметь навыки самоорганизации и планирования работы.
Кто такой технический писатель
Технический писатель, или техпис ― это специалист, который пишет техническую документацию для внешнего и внутреннего пользования.
Чаще всего технические писатели имеют техническое образование. Это не обязательное требование, и специалисты с гуманитарным складом ума могут разобраться в нюансах, но на практике такие случаи редки.
Что делает технический писатель:
- пишет руководства ― для пользователей, специалистов по установке и администраторов;
- создаёт технические задания;
- участвует в локализации интерфейсов;
- разрабатывает внутренние руководства самого разного назначения;
- занимается аналитикой — правда, не всегда;
- может создавать коммерческие тексты: рассылки, релизы, рекламные буклеты.
Кроме специфических для компании часто встречаются такие требования к специалистам:
- опыт работы техническим писателем — в среднем 1‒3 года;
- знание стандартов оформления технической документации;
- умение описывать сложные вещи просто и доступно;
- знание английского языка — минимум на уровне понимания профессиональных текстов.
Для техписа главное ― разбираться в продукте. Красота стиля и подачи материала вторичны.