Карьера в IT: должность Technical Writer

Важные качестваГде учитьсяЗарплата на 04.11.2020

(буквальный перевод английского названия профессии technical writer) Кстати, в 2021 году центр профориентации ПрофГид разработал точный тест на профориентацию. Он сам расскажет вам, какие профессии вам подходят, даст заключение о вашем типе личности и интеллекте.

Технический писатель – специалист, занятый разработкой документации для решения технических задач. В частности, он может создавать руководства пользователя к приборам, разрабатывать и поддерживать документацию к компьютерным программам.

Особенности профессии

Главная задача технического писателя – объяснить пользователям, как им лучше использовать функции прибора или программы. Важно, чтобы текст легко читался и был понятен после первого прочтения.

В некоторых случаях технические писатели используют графические редакторы, чтобы сделать свои пояснения наглядными. В качестве иллюстраций используются не только статичные картинки, но и анимация (flash-ролики).

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

Технический писатель

Аннотация

Технический писатель – это специальность, являющаяся весьма востребованной. Технический писатель занимается написанием документации для решения технических задач, поэтому работают такие специалисты в компаниях, разрабатывающих программные продукты, бытовую технику и аппаратуру для профессионального использования в медицине, науке и технике. Особенностью данной профессии является то, что автор должен уметь создавать технические тексты разных стилей, сочетая в себе задатки «лирика» и «физика». Пройдя обучение, слушатели получат знания, необходимые для работы с документацией, научатся писать тексты различных стилей на техническую тематику (технические статьи, технические задания, руководства пользователей, руководства по технической эксплуатации, формуляры и др.) на основе отечественных и зарубежных стандартов документирования, а также легко смогут применить приобретенные умения и навыки в реальных рабочих условиях.

Описание образовательной программы

Успешное окончание обучения по программе курса позволит специалистам: Знать:

• существующие виды и стили технических документов
• основные принципы и единые стандарты технического документирования
• этапы и тонкости разработки технической документации

Уметь:

• разрабатывать техническую и программную документацию разного типа от технических статей до руководств пользователя
• работать с технической документацией на иностранном языке
• использовать программное обеспечение для разработки техдокументации
• создавать обучающие видеоролики

Владеть:

• терминологией и грамотным подходом при разработке технических документов различного стиля
• навыками верстки технической документации

• навыками оформления скриншотов

Цель курса

Формирование знаний и умений, необходимых для разработки технических текстов различного назначения.

Целевая аудитория

• IT-специалисты
• Разработчики технической документации
• Технические писатели
• Студенты технических специальностей

Необходимая подготовка

Приветствуется наличие технического образования, опыт разработки технической документации или работы в ИТ-сфере.

Содержание

• Профессия технический писатель
• Особенности написания технической документации
• Этапы документирования
• Работа с задачей на документирование
• Основные принципы написания технической документации
• Особенности разработки ГОСТовой документации
• Разработка внутреннего руководство по стилю
• Типы программных продуктов
• Предмет документирования
• Способы чтения документации пользователем
• Детальность изложения в технической документации
• ГОСТ 19
• ГОСТ 34
• Структура ТЗ
• Структура Руководства пользователя
• Международные стандарты документирования
• Особенности написания документации на английском языке
• Основные ошибки в вёрстке технической документации
• Правила вёрстки
• Плюсы и минусы различных программ для вёрстки
• Основные принципы дизайна
• Роль скриншотов в документе
• Правила оформления скриншотов
• ПО для планирования рабочего времени
• ПО для написания документации
• ПО для создания и оформления скриншотов
• ПО для создания иллюстраций и схематических изображений
• ПО для работы с виртуальными машинами
• Создание обучающих видеороликов
• ПО для создания обучающих видеороликов

Практические задания:

• Обсуждение фрагментов инструкции.
• Написание простой инструкции.
• Поиск необходимого документа и чтение необходимого ГОСТа.
• Оформление Руководства пользователя по ГОСТу.
• Сверстать документ.
• Найти 3 некорректных и 3 корректных скриншота.
• Написать инструкцию и вставить в неё скриншоты.

Получаемый документ

Знания и навыки

Необходимы технические знания в объёме, который позволяет разобраться в новом продукте, системное видение документирования как инженерной дисциплины, понимание процессов документирования.

В работе над новой программой нужны базовые навыки программирования. Для создания иллюстраций требуется знание графических программ (Adobe PhotoShop, Adobe Flash и др) .

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

Очень важно уметь ясно выражать свои мысли в тексте.

Должностная инструкция технического писателя

Общество с ограниченной ответственностью «Бета» ООО «Бета»

УТВЕРЖДАЮ Генеральный директор ООО «Бета» ___________________ А.И. Петров

10.05.2016

Должностная инструкция технического писателя

10.05.2016 № 201-ДИ

г. Москва

1. ОБЩИЕ ПОЛОЖЕНИЯ

1.1. Настоящая Должностная инструкция определяет должностные обязанности, права и ответственность Технического писателя ООО «Бета».

1.2. Технический писатель назначается на должность и освобождается от должности приказом генерального директора ООО «Бета» по представлению начальника IT-отдела.

1.3. Технический писатель подчиняется непосредственно начальнику IT-отдела ООО «Бета».

1.4. На должность Технического писателя назначается лицо, имеющее высшее образование – специалитет, магистратура и опыт составления многостраничных текстов делового, учебного, научного характера (отчетов, статей, научных работ).

1.5. Технический писатель должен знать: − понятия «техническое средство», «программное средство», «комплекс», «система», содержание этих понятий, различия между ними; – основные типы эксплуатационных документов, адресованных пользователям, их особенности; – основные стандарты на эксплуатационную документацию, в том числе на документацию пользователя; – общие требования к структуре разделов технического документа; – терминологию, применяемая для описания интерфейса пользователя компьютерных систем; – методику и стиль изложения документации пользователя (технических средств, программных средств); – информационно-справочный и поисковый аппарат документа; – основные виды авторской разметки текста технической документации; – основные стандарты оформления технической документации; – основные форматы электронных документов и особенности их использования; – современное состояние индустрии информационных технологий, основные подходы и тенденции; – методы системной и программной инженерии; – порядок проектирования, производства, поставки и внедрения, применения, эксплуатации, утилизации документируемой продукции; – нормативно-правовую базу применения стандартов; – стандарты документирования промышленной продукции, программных средств, систем (в т. ч. автоматизированных); – основные возможности и технические характеристики наиболее распространенных в настоящее время форматов электронной справки; – способы интеграции электронной справки в программные средства и системы; – перечень лидирующих средств разработки электронной справки, их основные функциональные возможности и технические характеристики; – владение средствами разработки электронной справки; – методика и стиль изложения документации пользователя (технических средств, программных средств); – гипертекст, его методические и стилистические особенности; – средства для записи видеороликов с экрана; – методические основы подготовки видеокурсов; – лексические и грамматические особенности устной речи; – основные форматы файлов видеороликов и особенности их использования; – инструменты:

– средства для набора текста (текстовый процессор, XML-редактор), средства подготовки снимков экрана, средства преобразования документов в выходные форматы, тестовый стенд;

– текстовые процессоры, средства подготовки графических схем;

– текстовые редакторы с поддержкой набора исходного кода, HTML-редакторы, XML-редакторы, средства разработки электронной справки заданного формата, тестовый стенд, средства управления версиями и трекинга ошибок;

– средства записи видеороликов с экрана, микрофон для профессиональной звукозаписи.

1.6. В своей деятельности Технический писатель руководствуется: – локальными нормативными актами ООО «Бета», в том числе Правилами внутреннего трудового распорядка; – приказами (распоряжениями) генерального директора ООО «Бета»; – настоящей Должностной инструкцией.

1.7. В период временного отсутствия Технического писателя его обязанности возлагаются на работника, назначаемого приказом генерального директора ООО «Бета».

2. ДОЛЖНОСТНЫЕ ОБЯЗАННОСТИ

Технический писатель выполняет следующие должностные обязанности: 2.1. Разработка пользовательских документов, а также стандартных технических документов на основе предоставленного материала: 2.1.1. Разработка эксплуатационного документа, адресованного конечному пользователю компьютерной системы: – изучение целевой аудитории документа, выяснение ее задач, потребностей в информации, уровня подготовки; – изучение основ предметной области; – изучение темы документа с точки зрения целевой аудитории и с учетом ее информационных потребностей; – составление подробного плана документа и его согласование с экспертами; – составление текста документа, подготовка иллюстраций; – согласование документа с экспертами; – преобразование документа в требуемый выходной формат.

2.1.2. Разработка технического документа в соответствии с заданным стандартом на основе предоставленного материала: – сбор исходных сведений и материалов; – согласование с экспертами состава сведений, приводимых в документе, и уровня подробности их изложения; – компоновка и оформление текста документа; – разработка структуры документа и ее согласование с лицами, которые обладают знаниями предметной области и/или документируемой продукции, достаточными для согласования технической документации на эту продукцию, а также наделенные необходимыми для этого полномочиями.

2.1.3. Создание электронной справки в заданном стандартном формате: – анализ технических требований к электронной справке; – выбор, установка и настройка средств разработки электронной справки; – формирование структуры электронной справки; – составление и разметка текста разделов электронной справки; – формирование файлов электронной справки в требуемом стандартном формате; – отладка электронной справки отдельно от программного средства или системы; – согласование текста электронной справки с экспертами; – отладка электронной справки в составе программного средства или системы; – передача заказчику исходных файлов, необходимых для формирования файлов электронной справки; – консультирование программистов по способам интеграции электронной справки в программное средство или систему.

2.1.4. Создание демонстрационного или обучающего видеоролика: – разработка концепции видеоролика; – согласование концепции видеоролика с экспертами; – выбор, установка и настройка средства записи видеороликов с экрана; – разработка сценария (включая полный текст) видеоролика; – согласование сценария с экспертами; – подготовка демонстрационных данных для съемки видеоролика; – подготовка элементов оформления видеоролика; – запись видеоряда и озвучивание видеоролика; – согласование видеоролика с экспертами.

3. ПРАВА

Технический писатель имеет право: 3.1. Требовать от своего непосредственного руководителя содействия в исполнении должностных обязанностей и реализации прав. 3.2. Повышать свою квалификацию. 3.3. Запрашивать лично или по поручению непосредственного руководителя от работников отчеты и документы, необходимые для выполнения должностных обязанностей. 3.4. Знакомиться с проектами решений генерального директора ООО «Бета», касающимися деятельности Технического писателя. 3.5. Представлять на рассмотрение своего непосредственного руководителя предложения по вопросам своей деятельности, в том числе ставить вопросы о совершенствовании своей работы, улучшении организационно-технических условий труда, повышении размера зарплаты, оплате сверхурочных работ в соответствии с законодательством и положениями, регламентирующими систему оплаты труда работников ООО «Бета». 3.6. Получать от работников ООО «Бета» информацию, необходимую для ведения своей деятельности.

4. ОТВЕТСТВЕННОСТЬ

Технический писатель несет ответственность: 4.1. За неисполнение или ненадлежащее исполнение своих обязанностей, предусмотренных настоящей Должностной инструкцией, – в соответствии с действующим трудовым законодательством. 4.2. За другие правонарушения, совершенные в период ведения своей деятельности (в т. ч. связанные с причинением материального ущерба и ущерба деловой репутации ООО «Бета»), – в соответствии с действующим трудовым, гражданским, административным и уголовным законодательством.

5. УСЛОВИЯ РАБОТЫ

5.1. Режим работы Технического писателя определяется в соответствии с Правилами внутреннего трудового распорядка, установленными в ООО «Бета». 5.2. Работодатель проводит оценку эффективности деятельности Технического писателя в соответствии с Комплексом мероприятий по оценке эффективности, утверждаемым приказом генерального директора ООО «Бета».

Должностная инструкция разработана в соответствии с Приказом генерального директора ООО «Бета» № 1-Пр от 01.06.2015.

Должностную инструкцию составила:

Начальник отдела кадров _________________________ Е.В. Васильева

С инструкцией ознакомлен:

10.05.2016 ________________ Д.В. Ефремов

Согласовано:

Юрист _________________________ Н.А. Павлов

10.05.2016

Сколько зарабатывают технические писатели?

Зарплата начинающего технического писателя начинается от 40 тыс. руб. в месяц. Средняя зарплата специалиста с опытом 2-3 года – 60-80 тыс. руб. в месяц. Специалисты, создающие документацию на английском языке, могут получать больше 150 тыс. руб. в месяц. Например, так платят в ИТ-компаниях, которые создают софт для западных рынков.

Технический писатель может работать как в офисе, так и удаленно, а также быть фрилансером. Средние цены на создание технической документации – от 500-1000 руб. за страницу (1800 знаков с пробелами). Например, разработка технического задания у фрилансера может стоить от 20 тыс. рублей, руководства для администратора – от 25 тыс. рублей. При заказе в компаниях эти документы будут стоить в 2 раза дороже.