Как стать автором
Обновить

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

Время на прочтение6 мин
Количество просмотров4.1K

Немного конкретики и определений. Поговорим о том, что из себя представляет реестр отечественного ПО

Речь пойдет о законе, который регулирует формирование списков отечественного ПО. Закон был создан еще в 2016 году и действует до сих пор. Все отечественные программы, их функционал и отличительные особенности записаны в этом реестре. Для чего вообще был создан реестр? Для того, чтобы поддержать российских разработчиков и дать им преимущество перед иностранными. Таким образом, цель закона — увеличить зону использования отечественного программного обеспечения.

Какие привилегии дает место в Реестре?

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

Что нужно обеспечить перед подачей заявки на внесение в Реестр

Для программ есть список требований, которым они должны полностью соответствовать:

  • Правообладателем программного обеспечения должен быть гражданин России (либо доля владения российским лицом должна быть свыше 50%).

  • Создание и разработка продукта должны происходить на территории России.

  • При наличии совладельцев, не являющихся гражданами России, платежные поступления на их счет не должны быть выше 30% от прибыли за программное обеспечение.

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

Чтобы ваше программное обеспечение попало в Реестр, вам необходимо заранее сделать ряд действий:

  • заранее собрать нужные документы;

  • создать кабинет компании на ГосУслугах;

  • создать электронную подпись;

  • зафиксировать на сайте вашей программы грамотную файл-справку и пользовательскую документацию;

Более детально о всех нюансах процедуры внесения в Реестр можно узнать по ссылке.

В среднем, чтобы полностью завершить внедрение своего ПО в Реестр, Вам понадобится около 70 дней. Это при условии, что все требования были выполнены корректно. Предварительный этап подготовки и подачи заявки занимает меньшую часть из этого, дольше всего придется ждать рассмотрение и подтверждение (или отклонение) вашего запроса работником Реестра. Согласимся: процедура долгая, однако результат того стоит. Ваш продукт получит преимущества перед иностранными аналогами, что, несомненно, является огромным плюсом.

О файл-справках, вспомогательных документах и инструкции для пользователей

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

Значимость файл-справок и помощи пользователям для ПО, которые хотят быть внесенными в Реестр, была выделена на конференции ISDEF 2021 специалистом по организационному и документационному обеспечению компании Fast Reports, у которой в Реестре находится шесть программ.

Специалист делает акцент на том, что если документация проработана недостаточно хорошо или выглядит «сырой», то скорее всего заявку на внедрение в Реестр отклонят.

Какие пункты должны быть выполнены для полноты документации:

Файл-справка, в которой содержится полное наименование всех рабочих аспектов ПО и инструкция, которая будет отвечать на вопросы об установке и использовании ПО;

  • Руководство Пользователя.

  • Руководство Программиста.

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

Основные обязательства к файл-справкам от Министерства цифрового развития:

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

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

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

Под всем этим подразумеваются шаги по разработке, созданию и использованию ПО, по типу процессов:

  • Техническая поддержка;

  • Проектирование

  • Модернизация

  • Установка

  • Тестирование

  • Подробное пояснение того, как решать вопросы и задачи, которые могут возникнуть во время работы с ПО.

Без вышеперечисленного вы получите сообщение от министерства, где подобный недочет будет отмечен. Когда-то мы сами получили такое письмо.

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

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

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

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

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

Что можно подразумевать под определением «доступность»? В первую очередь то, что ваша файл-справка будет открываться в любом формате и в любых условиях, онлайн или оффлайн. Будет плюсом, если ваша документация будет доступна в разных форматах (HTML, CHM, PDF). Возможно, этот процесс будет достаточно долгим, но выполнение его — одно из условий для занесения вашего ПО в Реестр.

Чтобы вашим программным обеспечением могли пользоваться госучреждения, файл-справка обязательно должна соответствовать ГОСТам 19 и 34 по требованию Минкомсвязи РФ.

О том, какие ошибки часто встречаются в пользовательской документации мы писали здесь - https://habr.com/ru/post/654411/

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

Всё вышеперечисленное делает процесс написания справки для пользователя — действительно долгим и трудоемким процессом, который хотелось бы упростить. И его можно упростить!

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

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

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

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

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

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

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

Мы искренне желаем успеха с подачей заявки в Реестр отечественного ПО.

Теги:
Хабы:
Всего голосов 8: ↑5 и ↓3+3
Комментарии3

Публикации

Истории

Ближайшие события

7 – 8 ноября
Конференция byteoilgas_conf 2024
МоскваОнлайн
7 – 8 ноября
Конференция «Матемаркетинг»
МоскваОнлайн
15 – 16 ноября
IT-конференция Merge Skolkovo
Москва
22 – 24 ноября
Хакатон «AgroCode Hack Genetics'24»
Онлайн
28 ноября
Конференция «TechRec: ITHR CAMPUS»
МоскваОнлайн
25 – 26 апреля
IT-конференция Merge Tatarstan 2025
Казань