Здравствуйте, в этой статье мы постараемся ответить на вопрос: «Профессия технический писатель». Если у Вас нет времени на чтение или статья не полностью решает Вашу проблему, можете получить онлайн консультацию квалифицированного юриста в форме ниже.
Ответ на вопрос не будет однозначным. С одной стороны, профессиональное образование в этом деле не помешает. Мест, где учиться, достаточно. Самый “официальный” вуз – это, конечно, московский Литературный институт им. А. М. Горького.
Плюсы и минусы профессии технического писателя
|
Плюсы: |
Минусы: |
|
|
Какими качествами должен обладать
Не важно, собираетесь вы творить только для души или нацелены на заработок. Для работы нужны следующие качества:
- Развитая речь. Написанное скудным языком читать никто не будет.
- Наблюдательность. Видеть невидимое, замечать незамеченное, находить оригинальное в обыденном – без этого не обойтись.
- Развитое воображение. Даже если вы списываете персонажа с лучшего друга, для реализации замысла ему порой нужно придать новые черты и поместить в небывалые обстоятельства. Творцам фэнтези и вовсе без фантазии не прожить.
- Богатый внутренний мир. Часто связан с двумя первыми пунктами. Помогает представлять переживания и чувства героев.
- Настойчивость. Магомет должен не просто идти к горе, а искать все способы подняться на вершину.
- Перфекционизм. Только непрерывное стремление к совершенству поможет стать им. Хотя бы в глазах других.
- Трудолюбие. Без правок создать шедевр почти невозможно.
К данной природой личным качествам необходимо добавить профессиональные:
- Грамотность. Не поспоришь.
- Умение добывать информацию. Порой писатель, как и журналист, общается с десятками людей или исследует не один письменный источник, чтобы сотворить свое произведение. Именно так работал А. С. Пушкин над “Капитанской дочкой”. Сегодня таким образом пишут не только исторические романы, но и многочисленные воспоминания, биографии, различного рода советы (из серии “Как похудеть” или “Как заработать”).
- Организованность. Свое рабочее время планировали Пушкин, Толстой и другие профессиональные писатели. У них не было телевизора и соцсетей, но существовали служебные и семейные обязанности.
- Способность налаживать деловые контакты. Мало быть гением – надо еще и доказать это миру. Рекламировать себя издательствам и читателям, чтобы иметь коммерческий успех (кого коробят эти слова, читайте – “доход”). Не хотите “прогибаться под изменчивый мир” – публикуйтесь на Прозе.ру, в собственном блоге или на сайте. Но в таком случае писательство будет уже не профессией, а хобби.
Как начинающий, так и состоявшийся писатель в своей работе сталкивается с различными тяготами:
- Отсутствие четкого замысла. Люди, чья жизнь была насыщена яркими событиями, лелеют мечту “в конце жизни” засесть за роман. Немалый их процент предпринимает попытку, но несформированность идеи, системы персонажей и структуры произведения заставляют со временем забросить начатое.
- Непостоянство вдохновения. Увы, Муза не приходит по расписанию. Порой она бродит на стороне годами и ее слуга начинает испытывать подлинный творческий кризис. Единственное, что тут можно сделать, – поменять местами хозяйку и раба. Вызывать, понукать, насиловать ее и себя. Мучить дедлайнами и премировать приятными мелочами. Метод кнута и пряника хорош и для самовоспитания.
- Трудность словесного выражения образа. Бывает у всех, но решается упорным трудом.
- Нехватка времени. Если художественное творчество не приносит достаточного дохода (как в большинстве случаев), суета материального мира оставляет все меньше возможностей им заниматься. Но настоящий писатель – тот, кто работает вопреки всему.
- Невостребованность. Молодой талант пробивается далеко не сразу, снискавший первый успех рискует не повторить его, а признанный гений может попасть под какие-либо санкции (например, в СССР долго не печатали набоковскую “Лолиту”).
Технический писатель по канону
«Классический» технический писатель в компании занимается написанием не только внутренней документации на проекте, но и внешней — для заказчиков.
Внутренняя документация — это, например, описание админки, процесса продажи/возвратов/рассрочки, БД MongoDB. А внешняя обычно включает в себя описание верхнего уровня проекта: цели, требования, бизнес-эффект, а также мануал для работы сотрудников с разрабатываемым продуктом. Таким образом, технический писатель играет важную роль в команде вне зависимости от его специализации. Это не просто сотрудник, который пишет документацию, исходя из своей точки зрения и предпочтений. Техписатель-профессионал может почерпнуть «тайную» информацию от коллег-разработчиков и, что важно, принимает точку зрения каждого из коллег.
Кто такой технический писатель?
Так кто же такой технический писатель (сокр.техпис)? Технические писатели — это те люди, которые призваны помогать нам овладевать новыми технологиями, будь то модное устройство, либо же какая-нибудь новая программа. От этих людей отчасти зависит успех новинки, ведь именно им нужно убедить читателя в пользе этой новинки и объяснить, как ей пользоваться. Некоторые из читателей могут возразить, что вообще никогда не открывали никаких книг либо же инструкций, и прекрасно научились пользоваться нужным им девайсом или программой. Еще стоит добавить, что многое зависит от дизайна новинки, насколько он дружелюбен, понятен и интуитивен. В идеале было бы неплохо, чтобы разработчики уделяли дизайну первостепенное значение, и пользователю с первого взгляда было понятно как пользоваться устройством. Но, к идеалу можно стремиться всю жизнь и никогда не достичь его. Поэтому пока пользователю будет что-нибудь неясно, профессия технического писателя будет востребована на рынке труда. Ведь задача техписа — донести техническую (часто сложную) информацию простому пользователю, который не желает или не хочет узнавать все технические нюансы устройства или программы. Иными словами можно сказать, что техпис это своеобразный посредник или переводчик между техническими специалистами и обычными пользователями. Говоря научным языком, технический писатель — это профессиональный писатель, которые разрабатывает, составляет, поддерживает и обновляет различные виды технической документации, он-лайн помощи, руководств пользователя, инструкций, «белых бумаг», различных «ЧАВО» (авт. — часто задаваемые вопросы), разнообразных спецификаций и т.д. Сферы деятельности, где могут понадобиться услуги техписателя: машиностроение, приборостроение, медицинское оборудование и др. Но больше всего услугами технических писателей пользуются в сфере информационных технологий. В зависимости от проекта, техпис может выполнять следующие роли в нем:
- Переводчик, который переводит технические идеи, концепты и процессы на «нормальный, человеческий» язык;
- Хозяин, который встречает гостей в новом, страшном и сложном мире, и дает им почувствовать себя как дома;
- Друг, который помогает своим друзьям освоить что-то новое;
- Сосед, который все знает, и к которому можно обратиться с любым вопросом;
- Учитель, который зажигает какую-то искру в вас, и делает так, чтобы вы захотели изучить предмет;
- Исследователь, который уже побывал на неизвестной территории и теперь расставляет всевозможные знаки и подсказки, чтобы облегчить путь своему читателю;
- Гид, который увлекательно рассказывает читателям-туристам об иностранной стране;
Плюсы и минусы профессии технического писателя
| Плюсы: | Минусы: |
|
|
Мы пишем документацию в формате DITA. Это формат, основанный на XML, который позволяет сохранять исходный текст документов в структурированном виде. Мы пишем исходники документации в этом формате, для этого у нас есть редактор oXygen XML Author. Затем из этих исходников мы можем собрать итоговый документ в любом нужном формате. Для этого есть специальный Toolkit, содержащий XSLT-преобразования. Наш Toolkit позволяет собирать документы во множестве форматов. Самый востребованный — это PDF, иногда собираем CHM или HTML. При желании мы можем собрать даже EPUB, если заказчик вдруг захочет почитать нашу документацию перед сном на электронной книге. По необходимости мы вносим правки в XSLT-преобразования, чтобы изменить правила сборки документов и их внешний вид.
Основная задача Technical Writer — грамотно создавать, иллюстрировать и адаптировать документацию на понятном для конечного пользователя языке. Материал может предназначаться для потребностей команды/проекта (внутренняя) или для клиента продукта (внешняя).
«Главная обязанность позиции технического писателя — сделать документацию такой, чтобы ее читали».
Особенности работы технического писателя могут немного различаться в зависимости от поставленной задачи:
— Если этот специалист работает над материалом «от разработчика — клиенту», то сначала он изучает существующее ПО, а затем, разобравшись, пишет инструкции для конечного пользователя.
— Если в работе материал «от клиента к разработчику», то технический писатель вместе с бизнес-аналитиком оценивает потребности клиента, и затем доносит это до разработчиков в понятной им форме в виде спецификации или технического задания.
«Технические писатели — специалисты, которые технически сложные вещи могут объяснить простым человеческим языком, понятным конкретной аудитории. Они умеют писать, и одновременно разбираются в технике и технологиях».
Technical Writer обязан обладать глубокими знаниями в той области, о которой пишет, и уметь выражать суть максимально подробно и, вместе с тем, лаконично. Важно уметь работать с иллюстрациями — делать и обрабатывать скриншоты, создавать понятные графики, схемы, диаграммы. Также часто, особенно для работы с онлайн-справкой, необходимо иметь хотя бы базовые навыки HTML.
В круг обязанностей технического писателя может входить:
— Создание пользовательской документации, справочных систем;
— Создание документации для администраторов систем;
— Подготовка графических схем по заданным параметрам;
— Регулярное обновление уже существующей документации в соответствии с релизами ПО;
— Создание учебных материалов для новых пользователей.
«Фактически, технический писатель сталкивается не только с технической документацией, а и с другими материалами. Иногда доводится писать, редактировать или переводить release notes, software requirements specification, CV, PowerPoint презентации, meeting minutes, user stories и даже технические книжки, а также записывать обучающие how-to видео туториалы».
Основные инструменты технического писателя — текстовый редактор, диктофон, а также, в зависимости от особенностей проекта, руководства MS Manual of Style, Apple Style Manual, Chicago Manual of Style, программы MS Word, Adobe FrameMaker (для создания оффлайн-материалов), Adobe RoboHelp, MadCapFalre (для онлайн-документации) и другие.
Прежде всего, Technical Writer узнает, кто именно выступает экспертом предметной области (Subject matter expert) поставленного задания, и проводит с ним интервью — узнает все подробности про новый функционал. Затем анализирует, раскладывает систему на простейшие элементы, и в виде документации выдает результат конечному пользователю.
«Чаще всего я тесно работаю с программистами и product owner’ом. Последний дает общее направление по новинкам, которые следует включить в документацию, какие материалы корректно использовать, какие общие требования по оформлению документации согласно требованиям конкретного региона следует соблюсти. Программисты помогают мне разобраться в сути новых опций».
Типичный рабочий день Technical Writer включает в себя:
— Всестороннее изучение того, что должно быть включено в документацию в будущем (если релиза продукта еще нет);
— Создание новой документации для непокрытой функциональности;
— Обновление документации.
Обязанности технического писателя
Должностные обязанности технического писателя во многом зависят от того, чем занимается работодатель. К основным обязанностям относятся:
- Разработка технической документации (руководств пользователя и администратора, правил эксплуатации, ТУ, ТЗ, технических паспортов и прочих документов) в соответствии с требованиями ГОСТ и другими стандартами.
- Проверка и корректировка технической документации, поддержание ее в актуальном состоянии.
- Подготовка графических схем по заданным параметрам.
- Анализ новых программных продуктов и их тестирование.
- Сбор информации у всех участников процесса: заказчиков, разработчиков, дизайнеров, тестировщиков и менеджеров.
Также должность технического писателя может включать в себя дополнительные функции:
- Подготовка материалов технических презентаций.
- Обучение работе в новых программных продуктах и поддержка пользователей.
- Участие во внедрении программных продуктов.
- Составление документации на английском языке.
Нужно ли писателю специальное образование
Ответ на вопрос не будет однозначным. С одной стороны, профессиональное образование в этом деле не помешает. Мест, где учиться, достаточно. Самый “официальный” вуз – это, конечно, московский Литературный институт им. А. М. Горького.
Филфаки педагогических и гуманитарных университетов рады растолковать своим студентам премудрости словесного творчества. И замечательно, если властителями дум станут люди, разбирающиеся в законах жанра. Но вот совсем не обязательно выпускники вышеназванных вузов ими станут.
С другой стороны, в большой литературе велик процент “самоучек”. У А. П. Чехова было медицинское образование, Г. Г. Маркес по настоянию родителей учился на юриста, И. А. Гончаров окончил коммерческое училище. И ничто не помешало подлинным талантам пробиться в большую литературу.
Технический писатель должен:
- хорошо разбираться в своей профессиональной области;
- свободно владеть языком, на котором готовит документацию, составлять тексты без орфографических, пунктуационных и стилистических ошибок;
- иметь представление о программировании, вычислительной технике, информационных продуктах;
- быть в курсе, чем занимаются коллеги смежных специальностей;
- владеть компьютером на уровне уверенного пользователя, знать специальные программы по редактированию текста, верстке и web-дизайну;
- уметь в короткие сроки осваивать новые компьютерные программы и их обновления;
- владеть техническим английским языком;
- иметь навыки самоорганизации и планирования работы.
Кто такой технический писатель и чем он занимается?
Технический писатель – это специалист, который создает документацию к программам, интернет-сервисам, оборудованию и устройствам. Это могут быть как документы для инженеров и разработчиков, так и руководства для пользователей. Например, инструкция к смартфону, ноутбуку, метеостанции.
В функции технических писателей входит подготовка ТЗ, руководств, инструкций и других документов. По ним люди, которые будут пользоваться программами или оборудованием или участвовать в их доработке, смогут разобраться, что и как устроено и как работает. Технический писатель – это профессия, которая требует ответственности.
В должностные обязанности технического писателя входит:
- Сбор, анализ и систематизация данных о программе и ином продукте, для которого создается документация.
- Взаимодействие с разработчиками, проведение с ними интервью для получения необходимой информации.
- Подготовка технической документации, отвечающей требованиям нормативных документов. Например, ГОСТ.
- Редактирование и обновление технической документации, руководств и инструкций. Например, при обновлении ПО, выходе новых версий программ.
- Создание внутренних справочно-информационных систем, баз знаний для разработчиков.
- Подготовка отчетов о проделанной работе.
Иногда в обязанности технических писателей включают работу над интерфейсами, локализацию. Например, необходимо перевести интерфейс программы с английского языка. Технический писатель подбирает термины на русском языке, которые наиболее близки к оригиналу, чтобы пользователи поняли, где и какие функции находятся.
▍ Принцип написания инструкций
Без инструкций было бы сложно научиться пользоваться новыми технологиями и полезными функциями. Инструкция определяет порядок правил, согласно которым выполняется ряд определённых действий:
- Определяемся, для кого создаётся инструкция: конечные пользователи, сотрудники среднего звена, руководство, общая для всех, для клиентов.
- Пишется тема или заголовок.
- Создаются колонтитулы, где размещаются фирменные иконки, девиз, короткое название темы инструкции, а также добавляется нумерация страниц.
- Если используется профессиональная терминология, то необходимо подготовить перечень терминов с расшифровкой.
- Далее нужно продумать организационную структуру каждого раздела. Одним из удобных вариантов может быть составление скелета инструкции. Например, набросали 5-10 пунктов, пронумеровали и дали им названия. Это вносит большую ясность, что за чем описывать и что необходимо ещё добавить. Дальше идёт описание каждого пункта.
Если текста много, то лучше разбивать на абзацы или сделать дополнительный пункт, так как сплошной текст труднее читать. При описании лучше указывать простые и понятные действия, типа: нажатие кнопки “Экспорт”, использовать меню “Параметры”, а также результат: получим данные в виде таблицы или появится мастер настроек.
- При описании какого-либо функционала продукта крайне желательно прикреплять подтверждения в виде таблиц, схем, алгоритмов, картинок, скриншотов. Наглядность даёт большее понимание.
- Во время изложения своих мыслей необходимо задавать самому себе некоторые вопросы типа: а зачем?, действительно ли так?, подходит ли? Если описание в тексте раскрывает вопрос, то движение идёт в правильном русле.
- Различные выделения текста (жирный, подчёркнутый, наклонный, другим шрифтом и размером) бросает внимание на нужные фразы, настройки, действия. Также желательно отделять какие-то блоки текста тонкими линиями или готовыми маркерами. Например, такие блоки, как “Для справки”, “Примечание”, “Важно”, “Внимание” и другие.
- По завершении работы над инструкцией (обязательно) начинается работа над ошибками. Нужно проверить, читается ли текст легко, самому ли всё нравится, затем дать на проверку такому же специалисту, а после этого — разослать нескольким работникам и узнать, всё ли понятно.
- После одобрения word-овского варианта инструкции желательно оформить её в pdf-формате.