Технический писатель: с чего начать
Здравствуйте, в этой статье мы постараемся ответить на вопрос: «Технический писатель: с чего начать». Если у Вас нет времени на чтение или статья не полностью решает Вашу проблему, можете получить онлайн консультацию квалифицированного юриста в форме ниже.
Ответ на вопрос не будет однозначным. С одной стороны, профессиональное образование в этом деле не помешает. Мест, где учиться, достаточно. Самый “официальный” вуз – это, конечно, московский Литературный институт им. А. М. Горького.
Что делают технические писатели и чем занимаются?
Обязанности на примере одной из вакансий:
- разработка технической эксплуатационной документации и конструкторской документации на существующую и новую продукцию компании (ТУ, ТО, руководства по эксплуатации, паспорта, формуляры, чертежи, схемы и пр.);
- подготовка документации в соответствии с требованиями ЕСКД, проверка КД на соответствие требованиям ЕСКД;
- анализ требований проекта, требований ТЗ;
- разработка/доработка ТЗ;
- согласование технических решений с представителями разных подразделений компании, с заказчиком.
Чем важна и уникальна профессия
Заметим, что документация, с которой работает данный специалист, может предназначаться для внутреннего или внешнего использования.
Составляя «внутренние» технические документы, их автор обеспечивает оперативный обмен информацией между всеми звеньями производственной цепочки. Задача технического писателя – добиться того, чтобы все сотрудники, задействованные в процессе выпуска продукции, имели единое понимание относительно:
- характеристик отдельных деталей;
- правил эксплуатации приборов, аппаратных комплексов, инструментов;
- порядка применения программного обеспечения;
- методик испытания продукта.
«Внешнюю» документацию технический писатель составляет для клиентов, заказчиков, инвесторов и других заинтересованных лиц «со стороны». В презентациях, рекламных брошюрах, на фирменном сайте компании данный эксперт должен представить сложную для понимания техническую информацию в легкой для восприятия форме.
На промышленных предприятиях автор инженерной документации – это один из первых сотрудников, кто включается в работу с новым изделием. Он изучает и описывает его.
Какими качествами должен обладать
Не важно, собираетесь вы творить только для души или нацелены на заработок. Для работы нужны следующие качества:
- Развитая речь. Написанное скудным языком читать никто не будет.
- Наблюдательность. Видеть невидимое, замечать незамеченное, находить оригинальное в обыденном – без этого не обойтись.
- Развитое воображение. Даже если вы списываете персонажа с лучшего друга, для реализации замысла ему порой нужно придать новые черты и поместить в небывалые обстоятельства. Творцам фэнтези и вовсе без фантазии не прожить.
- Богатый внутренний мир. Часто связан с двумя первыми пунктами. Помогает представлять переживания и чувства героев.
- Настойчивость. Магомет должен не просто идти к горе, а искать все способы подняться на вершину.
- Перфекционизм. Только непрерывное стремление к совершенству поможет стать им. Хотя бы в глазах других.
- Трудолюбие. Без правок создать шедевр почти невозможно.
К данной природой личным качествам необходимо добавить профессиональные:
- Грамотность. Не поспоришь.
- Умение добывать информацию. Порой писатель, как и журналист, общается с десятками людей или исследует не один письменный источник, чтобы сотворить свое произведение. Именно так работал А. С. Пушкин над “Капитанской дочкой”. Сегодня таким образом пишут не только исторические романы, но и многочисленные воспоминания, биографии, различного рода советы (из серии “Как похудеть” или “Как заработать”).
- Организованность. Свое рабочее время планировали Пушкин, Толстой и другие профессиональные писатели. У них не было телевизора и соцсетей, но существовали служебные и семейные обязанности.
- Способность налаживать деловые контакты. Мало быть гением – надо еще и доказать это миру. Рекламировать себя издательствам и читателям, чтобы иметь коммерческий успех (кого коробят эти слова, читайте – “доход”). Не хотите “прогибаться под изменчивый мир” – публикуйтесь на Прозе.ру, в собственном блоге или на сайте. Но в таком случае писательство будет уже не профессией, а хобби.
Плюсы и минусы профессии технического писателя
| Плюсы: | Минусы: |
|
|
Какими качествами должен обладать
Не важно, собираетесь вы творить только для души или нацелены на заработок. Для работы нужны следующие качества:
- Развитая речь. Написанное скудным языком читать никто не будет.
- Наблюдательность. Видеть невидимое, замечать незамеченное, находить оригинальное в обыденном – без этого не обойтись.
- Развитое воображение. Даже если вы списываете персонажа с лучшего друга, для реализации замысла ему порой нужно придать новые черты и поместить в небывалые обстоятельства. Творцам фэнтези и вовсе без фантазии не прожить.
- Богатый внутренний мир. Часто связан с двумя первыми пунктами. Помогает представлять переживания и чувства героев.
- Настойчивость. Магомет должен не просто идти к горе, а искать все способы подняться на вершину.
- Перфекционизм. Только непрерывное стремление к совершенству поможет стать им. Хотя бы в глазах других.
- Трудолюбие. Без правок создать шедевр почти невозможно.
К данной природой личным качествам необходимо добавить профессиональные:
- Грамотность. Не поспоришь.
- Умение добывать информацию. Порой писатель, как и журналист, общается с десятками людей или исследует не один письменный источник, чтобы сотворить свое произведение. Именно так работал А. С. Пушкин над “Капитанской дочкой”. Сегодня таким образом пишут не только исторические романы, но и многочисленные воспоминания, биографии, различного рода советы (из серии “Как похудеть” или “Как заработать”).
- Организованность. Свое рабочее время планировали Пушкин, Толстой и другие профессиональные писатели. У них не было телевизора и соцсетей, но существовали служебные и семейные обязанности.
- Способность налаживать деловые контакты. Мало быть гением – надо еще и доказать это миру. Рекламировать себя издательствам и читателям, чтобы иметь коммерческий успех (кого коробят эти слова, читайте – “доход”). Не хотите “прогибаться под изменчивый мир” – публикуйтесь на Прозе.ру, в собственном блоге или на сайте. Но в таком случае писательство будет уже не профессией, а хобби.
Внутренняя «кухня» — источники вдохновения
Начиная работать над очередной задачей, писатель изучает многочисленные источники информации и преобразует полученные оттуда данные в пользовательскую документацию. Источников у нас много. Самый главный — это технический проект (ТП), которые пишут бизнес-аналитики ещё до начала разработки. ТП — это закон для разработчиков, тестировщиков и технических писателей. В идеале всё должно быть реализовано именно так, как написано в ТП. На деле же оказывается, что итоговая реализация отличается от ТП. Вы знаете, как это бывает: что-то не учли, что-то поняли неправильно, что-то оптимизировали… Для того, чтобы узнать, как на самом деле всё было реализовано, мы используем техническое описание (ТО), которое пишут разработчики. Там есть больше технических подробностей, описаны изменения конкретных типов данных и таблиц в БД, приведены алгоритмы работы процедур серверного кода, приведены скриншоты добавленных или изменённых окон в клиентских приложениях. Без ТО нам было бы очень трудно написать полноценную документацию. К сожалению, разработчики иногда откладывают написание ТО на самый последний момент.
Есть ещё один важный источник — описание настроек интеграционного тестирования. Там подробно описаны все настройки, которые нужно сделать в системах, чтобы пройти все тестовые сценарии (тест-кейсы). Этот источник незаменим для написания руководств по настройке.
ТП, ТО и описание настроек — это основные источники, из которых писатель получает информацию. Но есть ещё множество дополнительных: исходный код серверных процедур и клиентских приложений, XML-описания параметров, страницы в базе знаний Wiki, наконец — вопросы разработчикам и тестировщикам в мессенджерах. Ну и, конечно, сами системы — их web-интерфейс, клиентские и серверные приложения.
Задача писателя — объединить всю полученную информацию и написать простую, понятную и хорошо структурированную документацию о системе или решении. Тут нужно быть очень внимательным — ничего не перепутать, не забыть, описать именно то, что было реализовано. Писатель должен самостоятельно разобраться во всех особенностях реализации, понять все алгоритмы и принципы работы системы от начала и до конца. Только так получится хорошая и качественная документация.
Чем важна и уникальна профессия
Заметим, что документация, с которой работает данный специалист, может предназначаться для внутреннего или внешнего использования.
Составляя «внутренние» технические документы, их автор обеспечивает оперативный обмен информацией между всеми звеньями производственной цепочки. Задача технического писателя – добиться того, чтобы все сотрудники, задействованные в процессе выпуска продукции, имели единое понимание относительно:
- характеристик отдельных деталей;
- правил эксплуатации приборов, аппаратных комплексов, инструментов;
- порядка применения программного обеспечения;
- методик испытания продукта.
«Внешнюю» документацию технический писатель составляет для клиентов, заказчиков, инвесторов и других заинтересованных лиц «со стороны». В презентациях, рекламных брошюрах, на фирменном сайте компании данный эксперт должен представить сложную для понимания техническую информацию в легкой для восприятия форме.
Написание руководств и инструкций – основная часть работы. А какие руководства бывают?
— Руководство пользователя
– руководство для рядовых пользователей. Описывается всё просто и понятно. Главное – функциональность, описания настроек может не быть.
— Руководство администратора
– документ для тех, кто ковыряется на уровне администратора в крупных комплексах. Пишется только для крупных систем, требующих специалиста, который будет контролировать их.
— Руководство разработчика
– это описание кода, баз данных, элементной базы и физических принципов. Делается для обучения новых сотрудников, чтобы организовать преемственность в коллективе и устранить проблему незаменимости, когда от конкретного специалиста зависит, по сути, вся компания, так как полностью разобраться в коде без него будет практически невозможно.
На поверку становись!
Когда писатель завершает работу над документом, он обязательно отправляет его на проверку. Документацию проверяют бизнес-аналитики, разработчики, тестировщики. Это очень важный этап, ведь писатель всегда может ошибиться — что-то неправильно понять, не учесть каких-то незадокументированных особенностей реализации.
Ещё наши документы проверяет наш профессиональный технический редактор. Он исправляет орфографические и грамматические ошибки, подчищает описки, следит за смысловой и логической чистотой документа, проверяет соблюдение руководства по стилю. Это руководство — наш маленький внутренний стандарт. В нём записаны разрешённые и запрещённые термины, правила оформления документов разных типов, приведены наиболее часто используемые фразы, конструкции и обороты. Руководство по стилю помогает нам писать документацию по общим для всех писателей правилам: единство стиля — прежде всего. В воображении читателя должен возникнуть собирательный образ одного крутого профессионала — писателя, который создаёт разные документы или разделы.
Технический писатель – это специалист по подготовке инженерной документации. Он выполняет следующие виды работ:
- составление документов, описывающих производственный процесс (пояснительные записки к проектам и чертежам, технические задания, инструкции, паспорта к готовым изделиям);
- поддержание инженерной документации в актуальном состоянии;
- редактирование технических текстов;
- описание правил, стандартов работ, алгоритмов выполнения действий;
- анализ, систематизация, группировка инженерной документации;
- оформление составленных текстов, при необходимости – верстка материала для печати;
- составление речей для докладов, презентаций сложной технической продукции;
- написание рекламных статей;
- перевод технической документации с одного языка на другой;
- ведение фирменного сайта компании;
- описание методик работы предприятия;
- подготовка пособий для обучения новых сотрудников;
- участие в составлении контрактов (при необходимости);
- составление описаний и инструкций к программным продуктам;
- ведение справочных ресурсов.
Технический писатель должен:
- хорошо разбираться в своей профессиональной области;
- свободно владеть языком, на котором готовит документацию, составлять тексты без орфографических, пунктуационных и стилистических ошибок;
- иметь представление о программировании, вычислительной технике, информационных продуктах;
- быть в курсе, чем занимаются коллеги смежных специальностей;
- владеть компьютером на уровне уверенного пользователя, знать специальные программы по редактированию текста, верстке и web-дизайну;
- уметь в короткие сроки осваивать новые компьютерные программы и их обновления;
- владеть техническим английским языком;
- иметь навыки самоорганизации и планирования работы.
В каком режиме может работать
В отличие от специалистов многих других профессий, техпис может работать не только как офисный сотрудник, но и как удалённый работник, при этом не теряя
свою функциональность. Здесь важно понять, когда реально необходимо работа в офисе (например, если работы всегда много и идёт непрерывное консультирование с сидящими в соседнем кабинете программистами), а когда это просто формальность и работать можно дома. Перечислять плюсы работы дома можно долго, а минусов существует всего два: может сузиться круг общения и, порой, трудно заставить себя работать. Дом – наша зона комфорта и ассоциируется прежде всего с отдыхом и расслаблением, а потом уже с работой. Плюс, при таком ри. Выбрать работу в офисе или удалёнку – решение каждого, но учитывать надо все указанные выше факторы. Можно одичать, можно залениться и провалить работу, можно взвалить на себя слишком много и сидеть не отрываясь. Нужен баланс.
Технический писатель должен:
- хорошо разбираться в своей профессиональной области;
- свободно владеть языком, на котором готовит документацию, составлять тексты без орфографических, пунктуационных и стилистических ошибок;
- иметь представление о программировании, вычислительной технике, информационных продуктах;
- быть в курсе, чем занимаются коллеги смежных специальностей;
- владеть компьютером на уровне уверенного пользователя, знать специальные программы по редактированию текста, верстке и web-дизайну;
- уметь в короткие сроки осваивать новые компьютерные программы и их обновления;
- владеть техническим английским языком;
- иметь навыки самоорганизации и планирования работы.
Обязанности технического писателя
Должностные обязанности технического писателя во многом зависят от того, чем занимается работодатель. К основным обязанностям относятся:
- Разработка технической документации (руководств пользователя и администратора, правил эксплуатации, ТУ, ТЗ, технических паспортов и прочих документов) в соответствии с требованиями ГОСТ и другими стандартами.
- Проверка и корректировка технической документации, поддержание ее в актуальном состоянии.
- Подготовка графических схем по заданным параметрам.
- Анализ новых программных продуктов и их тестирование.
- Сбор информации у всех участников процесса: заказчиков, разработчиков, дизайнеров, тестировщиков и менеджеров.
Также должность технического писателя может включать в себя дополнительные функции:
- Подготовка материалов технических презентаций.
- Обучение работе в новых программных продуктах и поддержка пользователей.
- Участие во внедрении программных продуктов.
- Составление документации на английском языке.