Разработка технической документации для ПО

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

Работаем с проектами любого масштаба — от стартапов до крупных корпоративных решений.

Получите консультацию по вашему вопросу

Заказать консультацию

Создаем структурированные и понятные документы

Глубокие знания в области разработки ПО и технического документирования

Адаптируем документацию под ваши цели, аудиторию и стандарты (ГОСТ, ISO или внутренние регламенты)

Почему вам критически необходима качественная техническая документация

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

Разработка
и сопровождение

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

Сдача ПО заказчику

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

Регистрация ПО
в Минцифры

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

Аудит и сертификация

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

Эффективное
использование

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

// Что мы предлагаем //

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

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

API-документация: Четкое описание интерфейсов, методов и примеров интеграции для разработчиков, использующих ваше API

Спецификации и требования: Документы, описывающие функциональные и нефункциональные требования к программному продукту

Руководства по эксплуатации и администрированию: Инструкции для системных администраторов по установке, настройке и поддержке ПО

Сопровождающая документация: Протоколы тестирования, журналы изменений, FAQ и другие материалы для поддержки жизненного цикла ПО

// этапы работы

Как мы подготовим для вас техническую документацию

Процесс максимально прозрачен и состоит из следующих этапов:

1 этап

Подготовительные работы

Получить консультацию

2 этап

Написание и согласование:

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

3 этап

Поддержка

Принципы нашей работы

Каждый проект уникален, поэтому процесс работы будет построен на глубоком погружении в продукт и взаимодействии с командой ваших разработчиков, архитекторов и аналитиков:

Глубокий анализ

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

Структурирование

Приводим информацию к общепринятым стандартам (IEEE, ГОСТ, ISO).

Ясность и точность

Пишем понятным техническим языком.

Визуализация

Для наглядности используем схемы и скриншоты, диаграммы (UML, BPMN).

Соблюдение сроков

Разрабатываем согласованный комплект документов в установленные сроки.

Актуализация

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

Берем на себя успешную регистрацию
брендов, программ, технических решений

Вся команда

Наше портфолио

Запишитесь на видеоконференцсвязь с экспертом

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

Работаем индивидуально.

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

Оставить заявку

// стоимость услуг

Стоимость внесение программы в реестр Минцифры

Окончательная стоимость формируется в зависимости от условий, таких как:

Объем и сложность программного обеспечения: количество функций, модулей, интеграций.
Состав пакета документации.
Наличие исходных материалов: техзадание, черновые наброски, диаграммы.
Необходимость реверс-инжиниринга: готовится ли документация по продукту «с нуля» или по готовому коду.

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

Анализ исходной информации

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

21 000 ₽

Срок анализа: 7 рабочих дней

Выбрать тариф

В тариф входит:

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

Разработка технической документации

Вы получаете от 11 до 13 технических документов на ПО

от 350 000 ₽

1-2 календарных месяца, срок зависит от вида и сложности ПО, а также объема работы и наличия квалифицированных консультантов со стороны заказчика

Выбрать тариф

В тариф входит:

ВНЕСЕНИЕ В РЕЕСТР МИНЦИФРЫ

Помощь при внесении ПО в реестр Минцифры. Контроль патентного поверенного и IT юриста.

100 000 ₽

Срок внесения в реестр от 1,5 до 2 месяцев

Выбрать тариф

В тариф входит:

Консультирование по вопросам подготовки документов
Авторская инструкция по сбору документов
Анализ и корректировка документов: 2 рабочих дня
Сопровождение онлайн подачи заявки
Поэтапная оплата услуг

// FAQ

Часто задаваемые вопросы

У нас нет только части необходимых документов, возьметесь ли вы за их разработку?

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

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

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

Каков состав пакета документов для регистрации программного обеспечения в реестре Минцифры?

Минимальный пакет включает:

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

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

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

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

Насколько глубоко ваши эксперты будут погружаться в наш код и проект?

Помимо взаимодействия с вашими разработчиками, архитекторами и продукт-менеджерами нам понадобится доступ к

демоверсии программного обеспечения, чтобы протестировать функции и сделать скриншоты;
ТЗ и архитектурным диаграммам, если они есть;
коду (желательно) для описания API, условий лицензии и сложных алгоритмов.

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

Подготовленный пакет документов будет полностью соответствовать требованиям регулятора по содержанию и оформлению. Наш IT-юрист поможет вам успешно пройти регистрацию в Минцифре.

Почему лучше доверить разработку документации вашим техническим писателям, а не нашим разработчикам?

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

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

Да, мы практикуем работу с гибкими подходами к документированию. В процессе наши технические писатели будут:

обновлять документы параллельно со спринтами;
использовать Confluence, Swagger для API и другие инструменты, интегрированные в вашу среду разработки;
фокусироваться на документировании стабильных и завершенных функций.

Такой подход поможет постепенно наращивать объем готовой документации.

// блог о патентном праве