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

Журавлев Денис

Что такое Реестр отечественного ПО?

С 1 января 2016 г. вступили в силу статья 12.1 Федерального закона от 27 июля 2006 г. № 149-ФЗ «Об информации, информационных технологиях и о защите информации» (в редакции Федерального закона от 29 июня 2015 г. № 188-ФЗ) и постановление Правительства Российской Федерации от 16 ноября 2015 г. №1236 «Об установлении запрета на допуск программного обеспечения, происходящего из иностранных государств, для целей осуществления закупок для обеспечения государственных и муниципальных нужд».

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

В чем преимущество нахождения в Реестре?

Находясь в Реестре Российских программ для ЭВМ и баз данных, отечественный производитель получает привилегии перед зарубежными разработчиками. В связи с политикой импортозамещения, компании с государственным участием в первую очередь обязаны искать необходимое ПО, произведенное в России, и закупать зарубежное только с мотивированным обоснованием невозможности покупки российских программ. Кроме того, находясь в списке, владелец получает право на реализацию ПО через партнеров без НДС.

Требования к программному обеспечению и правообладателям, подающим заявку в Реестр

Закон закрепил правила, по которым программы попадают в «Реестр Российских программ для ЭВМ и баз данных»

Программа должна быть российской. Исключительным правом на ПО должны обладать российские лица (более 50% должно принадлежать российскому госсударству, российским организациям или гражданам).
Производиться продукт также должен на территории Российской Федерации.
Если в цепочке учредителей или совладельцев есть иностранные лица, то выплаты в их пользу не могут превышать 30% от всех платежей за ПО.

Процесс внесения в Реестр

Для того чтобы программу внесли в список отечественного ПО, нужно подготовить пакет документов, зарегистрировать личный кабинет компании на ГосУслугах, обладать электронной подписью и иметь на сайте ПО проработанную, понятную пользовательскую документацию.
Вся процедура занимает в среднем – 70 дней, если все документы заполнены и условия выполнены правильно. Сама подготовка и подача документов занимает несколько дней. Всё остальное время уйдет на рассмотрение вашей заявки экспертом реестра. Процесс длительный, но игра стоит свеч, если вы хотите, чтобы ваш продукт обладал немалыми привилегиями над иностранными аналогами.

О пользовательской документации

Документация в наши дни - неотъемлемая часть любой программы. В ней прописаны важные аспекты, облегчающие пользователю работу с ПО. Именно поэтому руководство должно быть простым и понятым, не говоря уже о том, что качественная документация - это весомый критерий отбора в Реестр.

Важность пользовательской документации для продуктов, подающихся в Реестр, отметила в своем докладе на конференции ISDEF 2021 Наталья Александрова, специалиста по организационному и документационному обеспечению компании Fast Reports, шесть продуктов которой находятся в Реестре.

Наталья подчеркивает, что одной из самых частых причин отказа в занесении в Реестр – плохо проработанная документация на ПО.

Что должно входить в пакет документации:

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

Тут важно отметить, что если продукт предназначен только для конечного пользователя, то требование ограничивается только Руководством Пользователя. В противном случае нужно иметь Руководство Пользователя и Руководство Программиста.

Требования к документации от Министерства цифрового развития:

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

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

Если такую документацию не приложить, то вы получите в ответ письмо от министерства с замечанием, которое в своем время получили даже мы сами:

О руководстве пользователя

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

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

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

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

Во-вторых, доступность. Что подразумевается под доступностью? Когда пользователь может в любом формате в любое время получить доступ к вашей документации. В режиме онлайн, открывая ваше руководство на сайте, нажимая клавишу F1 в программе для вызова CHM файла-справки или в offline-режиме, читая документацию в PDF формате.
Задача не сложная, но долгая – переносить документ в HTML, CHM, PDF форматы. Но для попадания в Реестр это важно.

В-третьих, если вашей программой будут пользоваться крупные или государственные компании, документация должна соответствовать ГОСТам 19 и 34. Это требование Минкомсвязи РФ для включения программного продукта в «Единый реестр российских программ для электронных вычислительных машин и баз данных (реестр отечественного ПО)»

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

Написать пользовательскую документацию, которая будет соответствовать всем перечисленным требованиям – не трудно, но сколько времени на это уйдет? Есть ли способ быстро написать документацию?

Dr.Explain - программа, в которой вы сможете создать вашу пользовательскую документацию в различных форматах (CHM, HTML, PDF), тем самым создав из обычной справки качественное, многоформатное руководство пользователя, соответствующее критериям качества как пользователей, так и экспертов Реестра.

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

Dr.Explain контролирует и автоматизирует поддержку требований стандартов к структуре и оформлению документов (ГОСТ). Программа следит за наличием обязательных разделов и снабжает все разделы пояснениями по их содержанию. Автоматизировано оформление титульных листов, аннотации и содержания.

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

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

Пользовательская документация к программе Dr.Explain была создана в ней же, и эта документация была одобрена экспертами совета при включении Dr.Explain в Реестр.

Желаем вам удачи с заполнением заявки в Реестр отечественного ПО, а документацию доверьте Dr.Explain.

Ознакомиться со всеми возможностями Dr.Explain - https://www.drexplain.ru/features/
Скачать Dr.Explain - https://www.drexplain.ru/