Результаты большого техписательского опроса, часть 2. ГОСТ, индустрии, виды документации, зарплаты

C вами Семён Факторович и компания documentat.io. С 2018 года мы помогаем IT-компаниям создавать техническую документацию: пишем документацию на заказ, консультируем инженерные команды по процессам документирования, учим техписателей и инженеров писать документацию.

В январе 2024 года мы провели большой социологический опрос среди техписателей и других IT-специалистов, разрабатывающих документацию. В этой серии статей я делюсь результатами нашего опроса.

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

В этой статье я расскажу об индустриях, в которых работают русскоязычные техписатели, о видах документов, которые они разрабатывают, о востребованности знаний ГОСТ и о том, как всё это влияет на техписательские зарплаты.

В предыдущей серии

Повторю ключевые характеристики и выводы нашего опроса из первой статьи.

• Мы опросили 365 русскоязычных техписателей из России, Сербии, Грузии, Армении, Германии и ещё 10 стран. Основная часть опрошенных (320 человек) живут в России.

• Статистика зарплат в нашем исследовании строится только по техписателям, проживающим в РФ. Все остальные параметры (половозрастное распределение, индустрии, используемый инструментарий) мы смотрим по техписателям из всех попавших в нашу статистику стран.

• Медиана Факторовича Медианная зарплата техписателя в РФ — 120 000 ₽ в месяц «чистыми». Половина российских техписателей получает меньше этой суммы.

• 95-й процентиль зарплат техписателей в РФ — 240 000 ₽ в месяц. Только 5% российских техписателей получает больше этой суммы.

• Если смотреть по медианным зарплатам, то техписатели, живущие в Москве, получают на 40% больше, чем техписатели в регионах.

А теперь продолжаем обсуждать результаты исследования.

Что мы документируем: софт или не софт?

Все ли русскоязычные техписатели документируют программное обеспечение? Многие ли из нас описывают не софт, а самолёты, станки, медицинские приборы и огромных человекоподобных роботов?

Вопрос 10.1. Что является объектом документирования на вашей текущей работе? Что вы описываете?

(сумма всех процентных результатов больше 100%, т.к. в вопросе можно было указать несколько ответов)

Суммарно около 20% опрошенных техписателей описывают «хардовые» объекты реального мира: серверное оборудование, приборы, станки, транспортные средства и т.д.

Значит ли это, что «софтовых» техписателей в разы больше, чем «хардовых»? Нет, не значит: я бы не стал экстраполировать этот результат на всё русскоязычное техписательское сообщество. Причина этому — некоторая однобокость методики нашего опроса.

Во-первых, большинство «хардовых» техписателей наверняка просто не знали про наш опрос. Я рекламировал опрос только в IT-сообществах (например, в жёлтом телеграм-чате техписателей) и вообще не выходил на профессиональные площадки, где общаются техписатели из неайтишных индустрий. Так получилось в первую очередь потому, что мне не известен ни один чат или форум, где общались бы, например, только техписатели из авиации. А ведь такие форумы и чаты наверняка существуют! Если вы общаетесь в узкоспециализированных онлайн-сообществах техписателей, то напишите об этом в комментариях к этой статье, будем знакомиться!

Во-вторых, во многих индустриях люди, разрабатывающие документацию, называются вовсе даже не техписателями. В производственных или приборостроительных компаниях создатели документации могут иметь должности конструкторов или инженеров-конструкторов. Методика нашего опроса, к сожалению, не включала их в итоговую выборку: мы отбирали только респондентов с должностью «техписатель».

Поэтому здесь вывод такой: среди русскоязычных техписателей точно есть те, кто документирует не софт, а осязаемые объекты. Насколько их общее количество сравнимо с количеством «софтовых» техписателей, наш опрос достоверно сказать не может. Я попробую узнать это точнее, когда буду повторять опрос в следующем году.

А что с зарплатами?

Отличаются ли зарплаты у «софтовых» и «хардовых» техписателей?

Разница в медианных зарплатах есть, но она не выглядит значимой: «софтовые» техписатели получают всего на 4% больше, чем «хардовые». Популярное мнение «техписателям на заводах платят куда меньше, чем в айти» нашим опросом не подтверждается.

Если софт, то для каких отраслей?

Мне показалось важным посмотреть распределение «софтовых» техписателей по индустриям и отраслям, а также выяснить разброс зарплат между отраслями.

Начнём с отраслей.

Вопрос 10.2. Если вы документируете программное обеспечение, то на какую индустрию или отрасль оно нацелено?

(сумма всех процентных результатов больше 100%, т.к. в вопросе можно было указать несколько ответов)

В трёх самых «населённых» техписателями отраслях — телеком, инструментарий для разработчиков, кибербезопасность — суммарно заняты почти две трети (61%) опрошенных техписателей. В этих отраслях документация почти всегда адресована суровым технарям: разработчикам, безопасникам, инфраструктурным инженерам. Получается, что как минимум двум третям русскоязычных техписателей необходимо применять в работе знания программной инженерии и computer science. Без этого невозможно описывать технически сложные предметные области и разговаривать со своей аудиторией на одном языке.

А что с зарплатами?

Отличаются ли медианные зарплаты «софтовых» техписателей в зависимости от отрасли?

Что значит «недостаточно данных»?

Для каждой из этих отраслей свои зарплаты указали 5 или менее респондентов. Я не счёл это количество достаточным для того, чтобы зарплатные метрики были достоверными, поэтому медианы для этих строчек не считались.

Интересные выводы:

• Во всех отраслях, где ПО — основной продукт (финтех, сервисы электронного правительства, кибербезопасность), медианные зарплаты примерно, с точностью до 10%, одинаковы. При этом они ещё и совпадают с общей техписательской медианой по РФ. Нет какой-то отрасли, где «софтовым» техписателям платили бы значимо больше.

• В отраслях, где ПО — не основной продукт, а вспомогательный инструмент (энергетика, логистика, нефтегазовая отрасль, наука), медианные зарплаты техписателей, документирующих ПО, ниже, чем общая техписательская медиана по РФ. Здесь нет противоречия с предыдущим разделом: выше мы говорили, что в неайтишных индустриях техписатели, документирующие объекты реального мира, а не софт, получают зарплаты по общерыночной медиане. Получается, что техписателю на заводе выгоднее документировать станки, а не ПО к станкам.

ГОСТ или не ГОСТ?

Правда ли, что почти все техписатели в России пишут по ГОСТу? Правы ли работодатели, включающие требования к владению ГОСТом чуть не в каждую техписательскую вакансию? 

Давайте начнём с компаний. В отношении использования документационных ГОСТов любая компания находится в одном из трёх состояний:

• Абсолютно вся документация пишется по ГОСТу. Отрасль компании и её клиенты в обязательном порядке требуют ГОСТ-комплекты, а не-ГОСТ документация, наоборот, никому не нужна.

• По ГОСТу пишется только часть документации — например, адресованная каким-то конкретным заказчикам или сертифицирующим органам. Всю остальную документацию компания пишет не по ГОСТу: например, публичную пользовательскую, которая выкладывается на сайт.

• ГОСТ при разработке документации вообще не используется: ни отрасль, ни клиенты компании этого не требуют. Вся документация пишется в свободной форме или по внутренним, отличным от ГОСТа, стандартам компании.

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

Поэтому в этой части наше исследование рассматривало три группы техписателей:

• На текущем месте работы пишу исключительно по ГОСТу.

• На текущем месте работы пишу по ГОСТу какую-то часть своей документации, а остальное пишу не по ГОСТу.

• Вообще не пишу по ГОСТу на текущем месте работы.

Распределение по этим группам получилось следующим:

Распределение удивительно равномерное: примерно половина русскоязычных техписателей (44%) пишет по ГОСТу, и примерно половина (56%) не пишет.

Для меня это было сюрпризом: я ожидал, что ГОСТ используют не менее 70% опрошенных.

Отдельно подчеркну: речь идёт о том, как ГОСТами пользуются техписатели, а не компании. Не стоит строить по этим данным какие-то выводы о типах российских компаний и их направленности. Если 8% русскоязычных техписателей пишут только по ГОСТу, значит ли это, что 8% российских компаний — государственные или работают на госзаказчиков? Неизвестно, хотя бы потому, что результаты опроса ничего не говорят о распределении техписателей по компаниям. Вполне могло сложиться так, что эти 8% работают в одной или двух компаниях.

Но в чём я абсолютно уверен, так это в следующем: на рынке труда есть спрос на написание документации и по ГОСТу, и не по ГОСТу. Обе эти специализации одинаково востребованы работодателями — именно это и является причиной почти равномерного распределения на графике выше.

Поэтому мои выводы здесь таковы:

• Если вы не хотите писать по ГОСТу, вы легко найдёте компанию, где это делать не нужно.

• Если вы хотите писать по ГОСТу, вы легко найдёте компанию, где это востребовано и где можно развиваться в этом направлении.

Если ГОСТы, то какие?

Вопрос 2.2. По каким ГОСТам вы работаете?

(сумма всех процентных результатов больше 100%, т.к. в вопросе можно было указать несколько вариантов ответов)

Документирование программных систем по ГОСТ 19 более востребовано (81%), чем документирование автоматизированных систем, совмещающих программное обеспечение и оборудование, по ГОСТ 34 (66%). Но, опять же, это может быть искажением, вызванным нашей фокусировкой на техписателях из IT.

Не возьмусь комментировать абсолютное значение процента использования военных ГОСТов (18% от всех техписателей, использующих ГОСТ). Более интересным мне кажется наблюдение за изменением этого показателя год к году. Да, мы обязательно повторим наш опрос в следующем году.

А есть ли разбивка по конкретным видам документов по ГОСТу?

Вопрос 2.3. Какие документы по ГОСТу вы разрабатываете?

Разрабатываемые документы	Количество техписателей, ответивших на вопрос	Процент от общего количества ответивших на вопрос
Руководство пользователя/администратора/оператора/программиста	111	81.02%
ПМИ (включая ПМ, ПМ ОЭ, ПСИ)	102	74.45%
ТЗ, ЧТЗ	82	59.85%
Руководства и инструкции по установке и настройке ПО, развёртыванию систем и т.д.	80	58.39%
Описание программы	77	56.2%
Руководство по эксплуатации	74	54.01%
ПЗ	68	49.64%
Технические условия	57	41.61%
Описание применения	55	40.15%
Ведомости	53	38.69%
Описание архитектуры (архитектурных решений, технической архитектуры)	50	36.5%
Спецификации (кроме ФТ)	48	35.04%
ОРД (протоколы и акты, как минимум формы, возможно в составе других документов)	35	25.55%
Схемы	33	24.09%
Входные, выходные данные	32	23.36%
Отчёт о тестировании	32	23.36%
Структура БД	25	18.25%
Программа обучения	23	16.79%
Отчёт по НИР	22	16.06%
Ролевая модель	22	16.06%
Технологические инструкции	21	15.33%
Спецификация ФТ	19	13.87%
Чертежи	11	8.03%
Расчёты	8	5.84%
Концепция	5	3.65%
Матрица прослеживаемости требований	3	2.19%
Всего	137	100%

(сумма всех процентных результатов больше 100%, потому что в вопросе можно было указать несколько вариантов ответов)

Наиболее часто разрабатываемые документы — все виды руководств (81%) и ПМИ, программа и методика испытаний (74%). 

Техзадания и ЧТЗ (частные технические задания) пишут 60% опрошенных ГОСТ-техписателей. Можно ли говорить, что 60% русскоязычных ГОСТ-техписателей совмещают свои обязанности с обязанностями аналитиков? Нет, нельзя: опрос не даёт чёткой информации о границах ответственности между техписателями и аналитиками в части разработки ТЗ и ЧТЗ. Вполне возможно, что для какой-то части из этих 60% техписателей работа над ТЗ сводится только к оформлению и вычитке уже написанных аналитиками требований. Поэтому сделаю следующие осторожные выводы:

• ТЗ и ЧТЗ — документы, часто встречающиеся в ГОСТ-комплектах.

• Техписатели часто прикладывают руку к их написанию, и как минимум хорошо знакомы с их типовой структурой.

А что с зарплатами?

Влияет ли использование ГОСТа на зарплату техписателя?

Медианная зарплата для техписателей, использующих ГОСТ и не использующих его, примерно совпадает, а вот картина по 95-м процентилям чуть интереснее. Я интерпретирую её так: техписатели, специализирующиеся на ГОСТе, имеют чёткий потолок зарплат, и он ниже, чем у техписателей, не пишущих по ГОСТу.

Если не ГОСТ, то что?

Вопрос 4.1. Какие виды документации не по ГОСТу вы разрабатываете на текущем месте работы?

(сумма всех процентных результатов больше 100%, потому что в вопросе можно было указать несколько вариантов ответов)

Интересные выводы:

• Самый популярный тип документации не по ГОСТу — руководства пользователя и администратора. Ими занимаются 83% техписателей.

• 54% техписателей разрабатывают руководства по установке не по ГОСТу. В современных реалиях такая документация чаще всего описывает операции в командной строке Linux, а также действия с Docker и Kubernetes. Я очень рад, что более чем у половины русскоязычных техписателей есть соответствующие навыки.

• Почти 40% техписателей документируют API.

• 20% техписателей документируют требования и/или пишут техзадания не по ГОСТу. Мне кажется, что это довольно небольшой процент. Судя по всему, мы гораздо меньше занимаемся требованиями, чем это можно представить по типовым техписательским вакансиям.

• Почти 11% техписателей документируют программную архитектуру. Такая документация однозначно требует хороших знаний программной инженерии: опять же, мне очень приятно осознавать, что немалый процент русскоязычных техписателей владеет этими навыками.

Архитектурные доки пишут всего 11% техписателей? Не мало ли?

Среди респондентов, не являщихся техписателями (системые аналитики, разработчики, тимлиды разработки) архитектурную документацию пишут те же 11%. Получается, что здесь нет перекоса «техписатели не описывают архитектуру, потому что ее описывают сами разработчики». Скорее верным будет утверждение «архитектурную документацию не пишет практически никто: ни инженеры, ни техписатели».

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

Я считаю, что архитектурная документация — это пока еще не занятая техписателями ниша. Если вы овладеете навыком ее написания, вы сможете приносить инженерным командам реальную пользу.

А что с зарплатами?

Как специализация в конкретных жанрах документов влияет на зарплаты?

Все эти зарплатные выборки делались независимо и не комбинировались. Другими словами, эта таблица не даёт ответа на вопросы типа «сколько в среднем получают техписатели, одновременно документирующие API и пишущие ТЗ»

Навыки работы с требованиями не влияют на уровень дохода, а вот умение документировать API и программную архитектуру повышают медианную зарплату техписателя на 10 и 30% соответственно.

Общие выводы

• Медианные зарплаты техписателей, документирующих софт, и техписателей, документирующих объекты реального мира, примерно равны.

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

• Зарплаты «софтовых» техписателей в IT практически не зависят от отрасли. Финтех, кибербезопасность, телеком, B2G — везде платят примерно одинаково, вровень с общероссийской медианой.

• 56% русскоязычных техписателей не пишет по ГОСТу, а 44% пишет. Если вы хотите найти себе работу без ГОСТа — вы её найдёте. Если вы хотите писать по ГОСТу, вы легко найдёте компанию, где это востребовано и где можно развиваться в этом направлении.

• Техписатели, пишущие по ГОСТу и не пишущие по ГОСТу, зарабатывают примерно одинаково.

• Умение документировать API повышает зарплату техписателя в среднем на 10%.

• Умение описывать программную архитектуру повышает зарплату техписателя в среднем на 30%.

Что дальше?

Это вторая статья из серии материалов о результатах нашего соцопроса. 

В следующей статье я расскажу о том, какой инструментарий используют русскоязычные техписатели: импортозаместился ли Confluence, сколько техписателей пишут в Word, какой процент техписателей уже перешёл на Docs as Code, и о многом другом.

Чтобы не пропустить новые статьи, подпишитесь на наш блог на Хабре и на телеграм-канал documentat.io.

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

Автор: Семён Факторович

Анализ данных: Илья Улеско

Редактура: Ната Мелихова

Инфографика: Валерий Балдин