Регистрация российского ПО: зачем нужен технический писатель

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

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

Технический писатель — это специалист, который создает структурированную техническую документацию. В его задачи входит разработка инструкций, спецификаций и справочных материалов, объясняющие сложные продукты и процессы. Цель — сделать информацию доступной для разных категорий пользователей, соблюдая технические стандарты.

Чем занимается технический писатель

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

Часто у компаний нет всей документации или она содержит минимальный набор данных. Если подать пакет документов на регистрацию без должной подготовки, последует отказ. Технический писатель помогает избежать таких ситуаций. Изучая документы, он определяет недостающие данные и обсуждает этот вопрос с клиентом. Он также может самостоятельно получить необходимые данные, работая с образцом программы.

Какие документы готовит технический писатель

• описания процессов жизненного цикла;
•  руководства пользователя;
• описания архитектуры;
•  инструкции по установке;
• иногда участвует в создании «Описания функциональных характеристик».

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

Существует мнение: технический писатель отнимает столько же времени у заказчика, сколько и программиста, а его все равно придется вводить в курс дела. Зачем тратить время?

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

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

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

Стоит ли привлекать технического писателя? На наш взгляд, да. Этот специалист наладит процесс и не допустит распространенных ошибок, которые приводят к отказу в регистрации в реестре отечественного ПО, а значит, компания быстрее сможет получить меры государственной поддержки и использовать их.