Здравствуйте, в этой статье мы постараемся ответить на вопрос: «Кто такие технические писатели и зачем они нужны IT-компании». Если у Вас нет времени на чтение или статья не полностью решает Вашу проблему, можете получить онлайн консультацию квалифицированного юриста в форме ниже.
Ответ на вопрос не будет однозначным. С одной стороны, профессиональное образование в этом деле не помешает. Мест, где учиться, достаточно. Самый “официальный” вуз – это, конечно, московский Литературный институт им. А. М. Горького.
Что должен знать и уметь технический писатель?
Требования к техническим писателям:
- Собирать требования к задаче
- Декомпозировать задачи
- Проводить интервью с техническими специалистами
- Передавать работу на вычитку и работать с правками
- Планировать работу над задачей в Trello
- Собирать данные по задаче
- Разрабатывать техническую документацию
- Разрабатывать техническое задание
- Использовать языки разметки Markdown, RST, asciidoc, XML
- Изучать целевую аудиторию продукта
- Работать с чертежами, таблицами, графиками, блок-схемами
Как стать техническим писателем и где учиться?
Варианты обучения для технического писателя с нуля:
- Самостоятельное обучение – всевозможные видео на YouTube, книги, форумы, самоучители и т.д. Плюсы – дешево или очень недорого. Минусы – нет системности, самостоятельное обучение может оказаться неэффективным, полученные навыки могут оказаться невостребованными у работодателя;
- Онлайн-обучение. Пройти курс можно на одной из образовательных платформ. Такие курсы рассчитаны на людей без особой подготовки, поэтому подойдут большинству людей. Обычно упор в онлайн-обучении делается на практику – это позволяет быстро пополнить портфолио и устроиться на работу сразу после обучения.
Ниже сделали обзор 15+ лучших онлайн-курсов.
Особенности профессии
Главная задача технического писателя – объяснить пользователям, как им лучше использовать функции прибора или программы. Важно, чтобы текст легко читался и был понятен после первого прочтения.
В некоторых случаях технические писатели используют графические редакторы, чтобы сделать свои пояснения наглядными. В качестве иллюстраций используются не только статичные картинки, но и анимация (flash-ролики).
В случае с программными продуктами технический писатель может подключиться ещё на стадии разработки. Он принимает в ней участие, обсуждая возможные варианты дизайна программы, действия функций, а также проводит тестирование. Также он может участвовать в написании Технического задания, документа «Программа и методика испытаний», которым пользуется при приемке системы.
Технический писатель должен:
- хорошо разбираться в своей профессиональной области;
- свободно владеть языком, на котором готовит документацию, составлять тексты без орфографических, пунктуационных и стилистических ошибок;
- иметь представление о программировании, вычислительной технике, информационных продуктах;
- быть в курсе, чем занимаются коллеги смежных специальностей;
- владеть компьютером на уровне уверенного пользователя, знать специальные программы по редактированию текста, верстке и web-дизайну;
- уметь в короткие сроки осваивать новые компьютерные программы и их обновления;
- владеть техническим английским языком;
- иметь навыки самоорганизации и планирования работы.
Сколько зарабатывают технические писатели?
Сколько получает технический писатель? Зарплата зависит от того, какие обязанности и на каких условиях выполняет данный специалист.
Если человек занят на крупном промышленном предприятии, где требуется готовить большие объемы текстов с описаниями производственных процессов, его ежемесячный доход составляет от 60 до 120 тыс. руб.
Специалист по составлению документации может стабильно зарабатывать в качестве фрилансера, обслуживая одновременно нескольких заказчиков. Многим фирмам проще оплатить разовые услуги, профессиональным исполнителем которых является технический писатель. Удаленно выполняя заказы, эксперт, зарекомендовавший себя на рынке, получает до 150 тыс. руб. в мес. Первые заработки начинающих специалистов составляют 5-10 тыс. руб. в мес.
Технарь +гуманитарий = технический писатель
Для того, чтобы стать первоклассным техписателем, нужны знания, как лингвистические, так и технические. Только очень тяжело найти такого специалиста, который бы одинаково хорошо владел обширными знаниями в обеих сферах. Расхожее мнение о разделении на «технарей» и «гуманитариев» подтверждает это. Тем выше ценится такой «универсальный» специалист — любой потенциальный работодатель будет согласен выложить кругленькую сумму за такого сотрудника. Лично я считаю, что лингвистическое образование должно быть обязательным для технического писателя, поскольку считаю, что никакие языковые курсы не помогут «технарю» хорошо овладеть языковой стороной процесса и отлично писать документацию, учитывая все особенности синтаксиса, стилистики английского языка. К тому же, спешу заявить, что далеко и не каждый лингвист сможет стать превосходным техническим писателем, ведь как ни крути, лингвист, в первую очередь, это гуманитарий, а гуманитарии, как всем известно, мыслят немного по-другому, чем те же «технари», и некоторым из них очень тяжело дается техническая специфика того или иного процесса. Какими же знаниями, способностями, умениями и качествами нужно обладать, чтобы стать хорошим техническим писателем и преуспеть в этом? Можно выделить несколько групп знаний и умений, но это не означает, что для того, чтобы стать писателем, вам нужно овладеть ими всеми. Языковые способности:
- Хорошее знание языка (грамматика, орфография, пунктуация)
- Способность сочинения различных текстов
- Навыки редактирования
- Технические знания:
- Знание ОС (Windows, Macintosh, Linux)
- Навыки программирования
- Навыки дизайна
- Личные качества:
- Самомотивация
- Навыки работы с людьми
- Умение распоряжаться временем
- Навыки проведения интервью
- Чувство юмора
- Умение быстро изучать новые программы и инструкции
- Умение доводить дело до конца
Внутренняя «кухня» — источники вдохновения
Начиная работать над очередной задачей, писатель изучает многочисленные источники информации и преобразует полученные оттуда данные в пользовательскую документацию. Источников у нас много. Самый главный — это технический проект (ТП), которые пишут бизнес-аналитики ещё до начала разработки. ТП — это закон для разработчиков, тестировщиков и технических писателей. В идеале всё должно быть реализовано именно так, как написано в ТП. На деле же оказывается, что итоговая реализация отличается от ТП. Вы знаете, как это бывает: что-то не учли, что-то поняли неправильно, что-то оптимизировали… Для того, чтобы узнать, как на самом деле всё было реализовано, мы используем техническое описание (ТО), которое пишут разработчики. Там есть больше технических подробностей, описаны изменения конкретных типов данных и таблиц в БД, приведены алгоритмы работы процедур серверного кода, приведены скриншоты добавленных или изменённых окон в клиентских приложениях. Без ТО нам было бы очень трудно написать полноценную документацию. К сожалению, разработчики иногда откладывают написание ТО на самый последний момент.
Есть ещё один важный источник — описание настроек интеграционного тестирования. Там подробно описаны все настройки, которые нужно сделать в системах, чтобы пройти все тестовые сценарии (тест-кейсы). Этот источник незаменим для написания руководств по настройке.
ТП, ТО и описание настроек — это основные источники, из которых писатель получает информацию. Но есть ещё множество дополнительных: исходный код серверных процедур и клиентских приложений, XML-описания параметров, страницы в базе знаний Wiki, наконец — вопросы разработчикам и тестировщикам в мессенджерах. Ну и, конечно, сами системы — их web-интерфейс, клиентские и серверные приложения.
Задача писателя — объединить всю полученную информацию и написать простую, понятную и хорошо структурированную документацию о системе или решении. Тут нужно быть очень внимательным — ничего не перепутать, не забыть, описать именно то, что было реализовано. Писатель должен самостоятельно разобраться во всех особенностях реализации, понять все алгоритмы и принципы работы системы от начала и до конца. Только так получится хорошая и качественная документация.
Каждый писатель редактирует DITA-файлы у себя в локальной копии, а затем выгружает изменения в SVN. Часто бывает так, что над одним документом работает несколько писателей. Чтобы в этом случае не было конфликта правок, у нас есть специальный чат, где можно оповестить своих коллег о начале работы с определённой частью документа или об обновлении общих коллекций, например — глоссария. Может, это и не самое технологичное решение, но оно работает. Никому из писателей не хочется потом «мёржить» (merge) куски сложных технических текстов.
После обновления локальной копии SVN начинается работа. Мы работаем по задачам в Jira. У нас есть специальный тип задач с префиксом DOC. Обычно они связаны с задачами на разработку или с запросами заказчиков. Задачи на документирование создают менеджеры, которые ведут проект, тестировщики, сотрудники службы поддержки. Заказчик тоже может инициировать изменение документации, задав вопрос, высказав пожелание или жалобу. Team Lead нашей команды планирует деятельность каждого писателя, распределяет задачи, следит за их выполнением и отгрузкой документов.
Для всех участников процесса разработки главное — не забыть создать задачу, ведь писатели должны откуда-то узнать о том, что что-то нужно задокументировать. К сожалению, у нас всё ещё бывают такие ситуации, когда подходит срок отгрузки новой системы, а заявка на документирование этой системы не создана. В этом случае чуда не произойдёт — документация не появится моментально.
Написание руководств и инструкций – основная часть работы. А какие руководства бывают?
— Руководство пользователя
– руководство для рядовых пользователей. Описывается всё просто и понятно. Главное – функциональность, описания настроек может не быть.
— Руководство администратора
– документ для тех, кто ковыряется на уровне администратора в крупных комплексах. Пишется только для крупных систем, требующих специалиста, который будет контролировать их.
— Руководство разработчика
– это описание кода, баз данных, элементной базы и физических принципов. Делается для обучения новых сотрудников, чтобы организовать преемственность в коллективе и устранить проблему незаменимости, когда от конкретного специалиста зависит, по сути, вся компания, так как полностью разобраться в коде без него будет практически невозможно.
Как стать техническим писателем и куда идти дальше
Чтобы стать техническим писателем в IT-компании, необходимо быть усидчивым, терпеливым и внимательным к деталям. Уметь работать с полученной информацией — раскладывать по полочкам архитектуру многоуровневых систем. Быстро разбираться в технических аспектах и описывать их в виде, подходящем для понимания конкретной аудиторией.
Не менее, чем системное аналитическое мышление, важны и коммуникативные навыки, умение общаться.
«Нужно уметь задавать разработчикам правильные вопросы, чтобы досконально изучить возможности ПО».
Что касается профессиональных знаний, то этой специальности не учат в университетах, а потому будущий tech writer должен освоить профессию самостоятельно: прочитать Microsoft Manual of Style, исследовать стиль написания документации больших технических компаний, научиться грамотно, последовательно, доходчиво и стилистически правильно излагать информацию.
«Важно много практиковаться — например, описать функциональность MS Word и дать почитать кому-то из старших родственников. Если они без проблем действуют по вашей инструкции — поздравляю, у вас есть задатки для tech writing!».
Для тех, кто хочет работать в аутсорсинговых компаниях, необходимо отличное владение иностранным языком. Базовые знания по HTML, XML, CSS, SQL, представление о системной и программной инженерии будут плюсом.
Стоит ознакомится с основными инструментами и технологическими средствами, которые используют технические писатели: Microsoft HTML Help Workshop, Help&Manual, RoboHELP, MadCapFalre, MadCap Software (разработка электронной справки), AuthorIT, DocBook/XML, DITA, SiberSafe (автоматизация документирования), Adobe FrameMaker, Microsoft Word, OpenOffice (подготовка технических публикаций), работа с IDEF0, DFD- и ER-диаграммами, UML.
«Мне кажется,что техническое образование все же предпочтительней. Но в нашей стране в этой профессии больше лингвистов».
Перспективы карьерного развития технического писателя:
— Расти как Technical Writer, углубляться в специальность;
— Вертикальный рост: стать руководителем подразделения технических писателей;
— Переквалифицироваться в бизнес-аналитика, тестировщика или верстальщика (если больше интересует техническая сторона);
— Двигаться в маркетологи или PR-отдел (если больше привлекает творчество).
На заметку: Если вас интересует правильная настройка яндекс директ, то в таком случае мы рекомендуем вам посетить сайт http://xn——6kcavbfcxglfd3akg7ahkqel41a.xn--p1ai/.
Технический писатель – это специалист по подготовке инженерной документации. Он выполняет следующие виды работ:
- составление документов, описывающих производственный процесс (пояснительные записки к проектам и чертежам, технические задания, инструкции, паспорта к готовым изделиям);
- поддержание инженерной документации в актуальном состоянии;
- редактирование технических текстов;
- описание правил, стандартов работ, алгоритмов выполнения действий;
- анализ, систематизация, группировка инженерной документации;
- оформление составленных текстов, при необходимости – верстка материала для печати;
- составление речей для докладов, презентаций сложной технической продукции;
- написание рекламных статей;
- перевод технической документации с одного языка на другой;
- ведение фирменного сайта компании;
- описание методик работы предприятия;
- подготовка пособий для обучения новых сотрудников;
- участие в составлении контрактов (при необходимости);
- составление описаний и инструкций к программным продуктам;
- ведение справочных ресурсов.
Нужно ли писателю специальное образование
Ответ на вопрос не будет однозначным. С одной стороны, профессиональное образование в этом деле не помешает. Мест, где учиться, достаточно. Самый “официальный” вуз – это, конечно, московский Литературный институт им. А. М. Горького.
Филфаки педагогических и гуманитарных университетов рады растолковать своим студентам премудрости словесного творчества. И замечательно, если властителями дум станут люди, разбирающиеся в законах жанра. Но вот совсем не обязательно выпускники вышеназванных вузов ими станут.
С другой стороны, в большой литературе велик процент “самоучек”. У А. П. Чехова было медицинское образование, Г. Г. Маркес по настоянию родителей учился на юриста, И. А. Гончаров окончил коммерческое училище. И ничто не помешало подлинным талантам пробиться в большую литературу.
Ошибки начинающих технических писателей
Большая часть ошибок, совершаемая техническими писателями, происходит от незнания специфики документации и от желания писателя самовыразиться. Эти два пункта друг другу противоречат – отсюда и проблемы. Человеку, особенно творческому, свойственно желание проявить свою индивидуальность, а техническая документация – это максимально безличная вещь. В идеале два технических писателя про одно и то же должны написать одинаковый текст. В реальности, конечно, такого не бывает, но для приближения к идеалу используются всевозможные ухищрения.
Например, стандарты. Даже если вам не предписывают руководствоваться какими-то явно прописанными стандартами (например, ГОСТ-ом или внутренним стандартом компании), все равно вы придете к тому, что будете использовать одинаковые формулировки, одинаковые фрагменты текста. Вы сами будете стандартизировать свой текст, потому что так проще и удобнее.
Или так называемая “технология единого источника” (single source). Она создана специально для облегчения работы с повторяющимся текстом. Используя единый источник, вы комбинируете текст из кусочков, как из конструктора. Причем кусочки могут быть созданы даже не вами, а другим писателем. И тут опять приходится наступать на горло собственной песне, потому что другой человек пишет не так, как вы. Вам хочется все переделать и переписать – а нельзя. Если этот кусочек используется еще где-то, то, переделав его, вы рискуете испортить кому-то его собственный документ.
И это не самое страшное. Самое страшное – это если ваш текст переводится на другие языки, да еще не на один. То есть локализуется. Чем больше необоснованных изменений в вашем тексте, тем больше лишней работы у инженеров по локализации и переводчиков, и тем дороже обходится локализация.
То, что приветствуется в художественных текстах: оригинальность, разнообразие, проявления личности автора, – становится камнем преткновения для начинающего технического писателя. Ведь в технических текстах ценится другое: точность и полнота информации, лаконичность, единообразие.
Так что, если вас заинтересовала работа технического писателя, будьте готовы к тому, что нужно будет научиться писать совсем иначе, чем если бы вы писали в художественном жанре. Ведь техническая документация отличается от художественной литературы настолько, насколько чертежи отличаются от полотен импрессионистов.
На поверку становись!
Когда писатель завершает работу над документом, он обязательно отправляет его на проверку. Документацию проверяют бизнес-аналитики, разработчики, тестировщики. Это очень важный этап, ведь писатель всегда может ошибиться — что-то неправильно понять, не учесть каких-то незадокументированных особенностей реализации.
Ещё наши документы проверяет наш профессиональный технический редактор. Он исправляет орфографические и грамматические ошибки, подчищает описки, следит за смысловой и логической чистотой документа, проверяет соблюдение руководства по стилю. Это руководство — наш маленький внутренний стандарт. В нём записаны разрешённые и запрещённые термины, правила оформления документов разных типов, приведены наиболее часто используемые фразы, конструкции и обороты. Руководство по стилю помогает нам писать документацию по общим для всех писателей правилам: единство стиля — прежде всего. В воображении читателя должен возникнуть собирательный образ одного крутого профессионала — писателя, который создаёт разные документы или разделы.
Какими качествами должен обладать
Не важно, собираетесь вы творить только для души или нацелены на заработок. Для работы нужны следующие качества:
- Развитая речь. Написанное скудным языком читать никто не будет.
- Наблюдательность. Видеть невидимое, замечать незамеченное, находить оригинальное в обыденном – без этого не обойтись.
- Развитое воображение. Даже если вы списываете персонажа с лучшего друга, для реализации замысла ему порой нужно придать новые черты и поместить в небывалые обстоятельства. Творцам фэнтези и вовсе без фантазии не прожить.
- Богатый внутренний мир. Часто связан с двумя первыми пунктами. Помогает представлять переживания и чувства героев.
- Настойчивость. Магомет должен не просто идти к горе, а искать все способы подняться на вершину.
- Перфекционизм. Только непрерывное стремление к совершенству поможет стать им. Хотя бы в глазах других.
- Трудолюбие. Без правок создать шедевр почти невозможно.
К данной природой личным качествам необходимо добавить профессиональные:
- Грамотность. Не поспоришь.
- Умение добывать информацию. Порой писатель, как и журналист, общается с десятками людей или исследует не один письменный источник, чтобы сотворить свое произведение. Именно так работал А. С. Пушкин над “Капитанской дочкой”. Сегодня таким образом пишут не только исторические романы, но и многочисленные воспоминания, биографии, различного рода советы (из серии “Как похудеть” или “Как заработать”).
- Организованность. Свое рабочее время планировали Пушкин, Толстой и другие профессиональные писатели. У них не было телевизора и соцсетей, но существовали служебные и семейные обязанности.
- Способность налаживать деловые контакты. Мало быть гением – надо еще и доказать это миру. Рекламировать себя издательствам и читателям, чтобы иметь коммерческий успех (кого коробят эти слова, читайте – “доход”). Не хотите “прогибаться под изменчивый мир” – публикуйтесь на Прозе.ру, в собственном блоге или на сайте. Но в таком случае писательство будет уже не профессией, а хобби.
▍ Принцип написания инструкций
Без инструкций было бы сложно научиться пользоваться новыми технологиями и полезными функциями. Инструкция определяет порядок правил, согласно которым выполняется ряд определённых действий:
- Определяемся, для кого создаётся инструкция: конечные пользователи, сотрудники среднего звена, руководство, общая для всех, для клиентов.
- Пишется тема или заголовок.
- Создаются колонтитулы, где размещаются фирменные иконки, девиз, короткое название темы инструкции, а также добавляется нумерация страниц.
- Если используется профессиональная терминология, то необходимо подготовить перечень терминов с расшифровкой.
- Далее нужно продумать организационную структуру каждого раздела. Одним из удобных вариантов может быть составление скелета инструкции. Например, набросали 5-10 пунктов, пронумеровали и дали им названия. Это вносит большую ясность, что за чем описывать и что необходимо ещё добавить. Дальше идёт описание каждого пункта.
Если текста много, то лучше разбивать на абзацы или сделать дополнительный пункт, так как сплошной текст труднее читать. При описании лучше указывать простые и понятные действия, типа: нажатие кнопки “Экспорт”, использовать меню “Параметры”, а также результат: получим данные в виде таблицы или появится мастер настроек.
- При описании какого-либо функционала продукта крайне желательно прикреплять подтверждения в виде таблиц, схем, алгоритмов, картинок, скриншотов. Наглядность даёт большее понимание.
- Во время изложения своих мыслей необходимо задавать самому себе некоторые вопросы типа: а зачем?, действительно ли так?, подходит ли? Если описание в тексте раскрывает вопрос, то движение идёт в правильном русле.
- Различные выделения текста (жирный, подчёркнутый, наклонный, другим шрифтом и размером) бросает внимание на нужные фразы, настройки, действия. Также желательно отделять какие-то блоки текста тонкими линиями или готовыми маркерами. Например, такие блоки, как “Для справки”, “Примечание”, “Важно”, “Внимание” и другие.
- По завершении работы над инструкцией (обязательно) начинается работа над ошибками. Нужно проверить, читается ли текст легко, самому ли всё нравится, затем дать на проверку такому же специалисту, а после этого — разослать нескольким работникам и узнать, всё ли понятно.
- После одобрения word-овского варианта инструкции желательно оформить её в pdf-формате.
Плюсы и минусы профессии технического писателя
Плюсы:
Минусы:
- Гуманитариям не всегда нравится отсутствие творчества в профессии, т.к. создание документации регламентировано нормами и стандартами.
- Некоторая монотонность труда. Если вам хочется заниматься более разнообразной деятельностью, рассмотрите профессию тестировщика.
-
Сложности в карьерном росте. Если вы не желаете работать на руководящих должностях, это не будет для вас минусом.