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

Редакция 1 от 16.02.2022

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

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

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

Спасибо за Вашу заявку!
В сервисе «Моё дело» можно работать с подписью ФНС
Подробнее