Кто такой технический писатель и чем он полезен для организации

Любое производство сопровождается составлением технической документации. Каждый текст нужно написать в соответствии с определёнными правилами и существующими стандартами.

Документ должен соответствовать трём пунктам:

1. Нормативным законодательным актам, принятым в отрасли.
2. Требованиям компании-разработчика проекта.
3. Правилам русского языка.

Технический писатель играет роль посредника между продуктом и пользователем.

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

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

Чем должен владеть технический писатель

От квалификации технического писателя зачастую зависит успех работы целой команды разработчиков проекта и продвижение продукта. Специалист должен иметь соответствующие знания по работе с технической документацией:

1. Навыки письма.
2. Знание английского языка.
3. Знание инструментов Google Docs, Confluence, Jira.

Ваш профессиональный успех будет зависеть и от наличия некоторых личностных качеств:

• любознательности;
• самостоятельности;
• общительности;
• доброжелательности;
• логического и перспективного мышления и др.

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

В каких областях востребованы технические писатели

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

1. IT-отрасль.
2. Наука.
3. Журналистика.
4. Электроника.
5. Энергетика.
6. Бизнес-планирование и др.

В зависимости от задач конкретного проекта вы можете работать как в офисе, так и в удаленном режиме. Если требуется постоянный контакт с программистами, руководителями, то работа в офисе будет более эффективна.

В других случаях технический писатель может работать удаленно и создавать заказанные ему документы:

• руководства;
• статьи;
• технические задания;
• презентации;
• интерфейсные подсказки;
• переводы.

Также предстоит заниматься вычиткой, редактурой, корректурой, актуализацией материалов. Эти функции можно выполнять как в офисе, так и в дистанционном режиме.

Что нужно знать о российских и зарубежных стандартах

Оформление технической документации должно производиться в соответствии с требованиями стандартов. В российской IT отрасли они следующие:

1. ГОСТ 19 (ЕСПД) — для описания программного обеспечения.
2. ГОСТ 34 (КСАС) — для документирования автоматизированных систем.
3. ГОСТ 2 (ЕСКД).

Стандарты выполняют функцию формализации документов и фиксируют нормативные обязательства участников разработки. Отечественные стандарты применяют при разработках ПО для внутреннего применения.

При заказах, связанных с международным сотрудничеством, применяют современные международные стандарты, касающиеся жизненных циклов программ и систем и их документирования (ISO, IEEE). Это «динамичные» стандарты, которые регламентируют основные процессы жизненных циклов программного обеспечения:

• приобретение;
• поставка;
• разработка;
• функционирование;
• сопровождение.

Они описывают модель жизненного цикла, ее архитектуру, но не прописывают конкретные детали и форматы. Динамичные стандарты дают всесторонний охват проекта, развивающегося во времени.