_________________ _______________
(наименование организации)
УТВЕРЖДАЮ
ИНСТРУКЦИЯ
_________________ ___________
(наименование должности)
00.00.0000 N 000
_________________ __________
(подпись) (инициалы, фамилия)
Технического писателя <1> 00.00.0000
1. Общие положения
1.1. Технический писатель относится к категории специалистов.
1.2. На должность технического писателя принимается лицо:
1) имеющее высшее образование - специалитет, магистратура;
2) имеющее опыт составления многостраничных текстов делового, учебного, научного характера (отчетов, статей, научных работ).
1.3. Технический писатель должен знать:
1) понятия "техническое средство", "программное средство", "комплекс", "система", содержание этих понятий, различия между ними;
2) основные типы эксплуатационных документов, адресованных пользователям, их особенности;
3) основные стандарты на эксплуатационную документацию, в том числе на документацию пользователя;
4) общие требования к структуре разделов технического документа;
5) терминологию, применяемую для описания интерфейса пользователя компьютерных систем;
6) методику и стиль изложения документации пользователя (технических средств, программных средств);
7) информационно-справочный и поисковый аппарат документа;
8) основные виды авторской разметки текста технической документации;
9) основные стандарты оформления технической документации;
10) основные форматы электронных документов и особенности их использования;
11) инструменты:
- средства для набора текста (текстовый процессор, XML-редактор);
- средства подготовки снимков экрана;
- средства преобразования документов в выходные форматы, тестовый стенд;
- текстовые процессоры;
- средства подготовки графических схем;
- текстовые редакторы с поддержкой набора исходного кода;
- HTML-редакторы;
- XML-редакторы;
- средства разработки электронной справки заданного формата, тестовый стенд;
- средства управления версиями и трекинга ошибок;
- текстовые процессоры;
- средства записи видеороликов с экрана;
- микрофон для профессиональной звукозаписи;
12) современное состояние индустрии информационных технологий, основные подходы и тенденции;
13) методы системной и программной инженерии;
14) порядок проектирования, производства, поставки и внедрения, применения, эксплуатации, утилизации документируемой продукции;
15) нормативно-правовую базу применения стандартов;
16) стандарты документирования промышленной продукции, программных средств, систем (в том числе автоматизированных);
17) основные возможности и технические характеристики наиболее распространенных в настоящее время форматов электронной справки;
18) способы интеграции электронной справки в программные средства и системы;
19) перечень лидирующих средств разработки электронной справки, их основные функциональные возможности и технические характеристики;
20) способы владения средствами разработки электронной справки;
21) гипертекст, его методические и стилистические особенности;
22) средства для записи видеороликов с экрана;
23) методические основы подготовки видеокурсов;
24) лексические и грамматические особенности устной речи;
25) основные форматы файлов видеороликов и особенности их использования;
26) Правила внутреннего трудового распорядка;
27) требования охраны труда и правила пожарной безопасности;
28) _________________ _______________________ _________________.
(другие требования к необходимым знаниям)
1.4. Технический писатель должен уметь:
1) опрашивать экспертов и анализировать полученные сведения;
2) исследовать программные средства на тестовом стенде;
3) анализировать техническую документацию, извлекать из нее сведения, необходимые для решения поставленной задачи;
4) составлять требования к эксплуатационному документу;
5) оценивать количество рабочих часов, необходимых для выполнения полученного задания;
6) составлять календарный план выполнения полученного задания;
7) разрабатывать:
- руководство по эксплуатации бытового прибора;
- руководство по установке прикладного программного средства;
- руководство пользователя прикладного программного средства;
- учебное пособие по прикладному программному средству;
- технологическую инструкцию для персонала автоматизированной системы;
8) составлять текст, адаптированный для автоматизированного перевода;
9) анализировать замечания экспертов и вносить исправления в документ;
10) преобразовывать документ в различные выходные форматы (PDF, HTML, формат электронной справки);
11) применять требования стандарта с учетом особенностей конкретного проекта;
12) подготавливать графические схемы;
13) компоновать документ на основе заданных источников;
14) проводить опрос экспертов и анализировать полученные сведения;
15) составлять информативные и лаконичные разделы электронной справки, понятные представителям целевой аудитории в отрыве от других разделов;
16) расставлять в гипертексте полезные для читателей гипертекстовые ссылки;
17) размечать текст в соответствии с правилами заданного языка разметки;
18) отлаживать программы и настраивать системы;
19) создавать простые элементы веб-дизайна;
20) пользоваться системой управления версиями;
21) пользоваться системой трекинга ошибок;
22) озвучивать видеоролики (иметь навыки дикторской или сценической речи);
23) _________________ _______________________ _________________.
(другие навыки и умения)
1.5. Технический писатель в своей деятельности руководствуется:
1) _________________ _______________________ _________________;
(наименование учредительного документа)
2) Положением о _________________ _______________________ _______;
(наименование структурного подразделения)
3) настоящей должностной инструкцией;
4) _________________ _______________________ _________________.
(наименования локальных нормативных актов, регламентирующих
трудовые функции по должности)
1.6. Технический писатель подчиняется непосредственно _________________
_________________ ___________________.
(наименование должности руководителя)
1.7. _________________ _______________________ ________________.
(другие общие положения)
2. Трудовые функции
2.1. Разработка пользовательских документов, а также стандартных технических документов на основе предоставленного материала:
1) разработка эксплуатационного документа, адресованного конечному пользователю компьютерной системы;
2) разработка технического документа в соответствии с заданным стандартом на основе предоставленного материала;
3) создание электронной справки в заданном стандартном формате;
4) создание демонстрационного или обучающего видеоролика.
2.2. _________________ _______________________ ________________.
(другие функции)
3. Должностные обязанности
3.1. Технический писатель исполняет следующие обязанности:
3.1.1. В рамках трудовой функции, указанной в пп. 1 п. 2.1 настоящей должностной инструкции:
1) изучает целевую аудиторию документа, выясняет ее задачи, потребности в информации, уровень подготовки;
2) изучает основы предметной области;
3) изучает темы документа с точки зрения целевой аудитории и с учетом ее информационных потребностей;
4) составляет подробный план документа и проводит его согласование с экспертами;
5) составляет текст документа, осуществляет подготовку иллюстраций;
6) проводит согласование документа с экспертами;
7) осуществляет преобразование документа в требуемый выходной формат.
3.1.2. В рамках трудовой функции, указанной в пп. 2 п. 2.1 настоящей должностной инструкции:
1) осуществляет сбор исходных сведений и материалов;
2) проводит согласование с экспертами состава сведений, приводимых в документе, и уровня подробности их изложения;
3) выполняет компоновку и оформление текста документа;
4) осуществляет разработку структуры документа и ее согласование с лицами, которые обладают знаниями предметной области и/или документируемой продукции, достаточными для согласования технической документации на эту продукцию, а также наделенные необходимыми для этого полномочиями (эксперты).
3.1.3. В рамках трудовой функции, указанной в пп. 3 п. 2.1 настоящей должностной инструкции:
1) проводит анализ технических требований к электронной справке;
2) осуществляет выбор, установку и настройку средств разработки электронной справки;
3) формирует структуру электронной справки;
4) осуществляет составление и разметку текста разделов электронной справки;
5) формирует файлы электронной справки в требуемом стандартном формате;
6) выполняет отладку электронной справки отдельно от программного средства или системы;
7) проводит согласование текста электронной справки с экспертами;
8) выполняет отладку электронной справки в составе программного средства или системы;
9) передает заказчику исходные файлы, необходимые для формирования файлов электронной справки;
10) консультирует программистов по способам интеграции электронной справки в программное средство или систему.
3.1.4. В рамках трудовой функции, указанной в пп. 4 п. 2.1 настоящей должностной инструкции:
1) разрабатывает концепцию видеоролика;
2) проводит согласование концепции видеоролика с экспертами;
3) осуществляет выбор, установку и настройку средства записи видеороликов с экрана;
4) осуществляет разработку сценария (включая полный текст) видеоролика;
5) проводит согласование сценария с экспертами;
6) осуществляет подготовку демонстрационных данных для съемки видеоролика;
7) осуществляет подготовку элементов оформления видеоролика;
8) выполняет запись видеоряда и озвучивание видеоролика;
9) проводит согласование видеоролика с экспертами.
3.1.5. В рамках выполнения своих трудовых функций исполняет поручения своего непосредственного руководителя.
3.1.6. _________________ _______________________ ______________.
(другие обязанности)
3.2. _________________ _______________________ ________________.
(другие положения о должностных обязанностях)
4. Права
Технический писатель имеет право:
4.1. Участвовать в обсуждении проектов решений, в совещаниях по их подготовке и выполнению.
4.2. Запрашивать у непосредственного руководителя разъяснения и уточнения по данным поручениям, выданным заданиям.
4.3. Запрашивать по поручению непосредственного руководителя и получать от других работников организации необходимую информацию, документы, необходимые для исполнения поручения.
4.4. Знакомиться с проектами решений руководства, касающихся выполняемой им функции, с документами, определяющими его права и обязанности по занимаемой должности, критерии оценки качества исполнения своих трудовых функций.
4.5. Вносить на рассмотрение своего непосредственного руководителя предложения по организации труда в рамках своих трудовых функций.
4.6. Участвовать в обсуждении вопросов, касающихся исполняемых должностных обязанностей.
4.7. _________________ _______________________ ________________.
(другие права)
5. Ответственность
5.1. Технический писатель привлекается к ответственности:
- за ненадлежащее исполнение или неисполнение своих должностных обязанностей, предусмотренных настоящей должностной инструкцией, - в порядке, установленном действующим трудовым законодательством Российской Федерации, законодательством о бухгалтерском учете;
- правонарушения и преступления, совершенные в процессе своей деятельности, - в порядке, установленном действующим административным, уголовным и гражданским законодательством Российской Федерации;
- причинение ущерба организации - в порядке, установленном действующим трудовым законодательством Российской Федерации.
5.2. _________________ _______________________ ________________.
(другие положения об ответственности)
6. Заключительные положения
6.1. Настоящая должностная инструкция разработана на основе
Профессионального стандарта "Технический писатель (специалист по
технической документации в области информационных технологий)",
утвержденного Приказом Министерства труда и социальной защиты Российской
Федерации от 08.09.2014 N 612н, с учетом _________________ _______________.
(реквизиты локальных нормативных
актов организации)
6.2. Ознакомление работника с настоящей должностной инструкцией
осуществляется при приеме на работу (до подписания трудового договора).
Факт ознакомления работника с настоящей должностной инструкцией
подтверждается _________________ _______________________ __________.
(подписью в листе ознакомления, являющемся неотъемлемой
частью настоящей инструкции (в журнале ознакомления
с должностными инструкциями); в экземпляре должностной
инструкции, хранящемся у работодателя; иным способом)
6.3. _________________ _______________________ ________________.
(другие заключительные положения)
--------------------------------
Информация для сведения:
<1> В соответствии с Профессиональным стандартом "Технический писатель (специалист по технической документации в области информационных технологий)", утвержденным Приказом Министерства труда и социальной защиты Российской Федерации от 08.09.2014 N 612н, иное возможное наименование должности - "разработчик технический документации".
