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

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

12% участников опроса ответили, что занимаются разработкой технической документации, однако лишь 9% сообщили, что это официально входит в их должностные обязанности.

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

Какую документацию вы пишете?

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

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

Подход «документация как код» набирает популярность: все больше людей (на 6 процентных пунктов больше, чем в 2021 году) используют для создания документации инструменты для разработки.

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

Markdown остается самым популярным языком разметки, а 13% технических писателей используют для него разные расширения.

Используете ли вы созданный контент повторно при написании документов или руководств?

Повторно используют созданный контент 80% респондентов, при этом треть до сих копирует его вручную.

6%

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

58%

респондентов ответили, что им нужно документировать API, при этом 61% создают документацию API автоматически. Обычно для этого используется Swagger.

30%

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

Для каких объектов вы настраиваете шаблоны?

47%

тех, кто использует шаблоны, создают параметризованные шаблоны.

На каком языке вы в основном пишете документацию?

Среди самых распространенных языков с большим отрывом лидирует английский. На втором месте — китайский, но его доля намного меньше.

68%

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

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

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

WritersideРанний доступ

Вы относитесь к тем 68%, кто рассматривает возможность использования специального инструмента для написания технической документации?

Присоединяйтесь к программе раннего доступа, чтобы попробовать Writerside:

работает с IDE на платформе IntelliJ;
поддерживает Markdown, семантическую разметку и их сочетание;
предлагает более 100 встроенных тестов для автоматического контроля качества документации;
поддерживает повторное использование контента с помощью условий и переменных;
имеет встроенные шаблоны для разных типов контента и сложных элементов разметки.

Попробовать

Предыдущий раздел