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

• Разработка и доработка программной и эксплуатационной документации

• Владение MS Office Word, Ecxel, Visio, PowerPoint
• Владение технической терминологией, знание структуры, стилистики технической документации, взаимосвязи между документами (руководства, how-to инструкции, спецификации и т.д.)
• Грамотный русский язык
• Знание стандартов и ГОСТов оформления документации (см. ниже)

• Понимание того, как устроены веб-серверные приложения, веб-сервисы, базы данных, объектные хранилища
• Знание основ SQL
• Умение составлять схемы и диаграммы UML и BPML
• Опыт работы с jira, confluence

Используемые стандарты при подготовке документации:

ГОСТ 19.101-2024 Единая система программной документации. Виды программ и программных документов

Программные документы:

Спецификация ГОСТ 19.202

Описание программы ГОСТ 19.402

Эксплуатационные документы:

Ведомость эксплуатационных документов ГОСТ 19.507

Формуляр ГОСТ 19.501

Описание применения ГОСТ 19.502

Руководство системного программиста ГОСТ 19.503

Руководство программиста ГОСТ 19.504

Руководство пользователя (оператора) ГОСТ 19.505

(+ ГОСТ 19.106 Требования к программным документам, выполненным печатным способом)

(+ ГОСТ 19.603 Общие правила внесения изменений)

ГОСТ 34.201— 2020 Информационные технологии. Комплекс стандартов на автоматизированные системы. Виды, комплектность и обозначение документов при создании автоматизированных систем, в т.ч.:

Виды документов на программные средства, используемые при создании АС (ее частей) — ГОСТ 19.101-2024

Виды документов на технические средства, используемые при создании АС (ее частей) — по ГОСТ 2.102-2013 и по ГОСТ 2.601-2019 в части эксплуатационных документов:

Руководство по эксплуатации

Инструкция по монтажу, пуску, регулированию и обкатке изделия

Формуляр

Паспорт

Ведомость ЗИП

Инструкции эксплуатационные специальные

Ведомость эксплуатационных документов

(+ ГОСТ Р 2.610-2019 Правила выполнения эксплуатационных документов)

(+ ГОСТ 2.503 — 2013 Правила внесения изменений)