API-документация: Четкое описание интерфейсов, методов и примеров интеграции для разработчиков, использующих ваше API
Разработка технической документации для ПО
Создание технической документации для программ ЭВМ под ключ, с учётом всех нюансов и требований Минцифры. Точное, понятное и структурированное описание вашей программы для ЭВМ.
Работаем с проектами любого масштаба — от стартапов до крупных корпоративных решений.
Получите консультацию по вашему вопросу
- Создаем структурированные и понятные документы
- Глубокие знания в области разработки ПО и технического документирования
- Адаптируем документацию под ваши цели, аудиторию и стандарты (ГОСТ, ISO или внутренние регламенты)
Почему вам критически необходима качественная техническая документация
Разработка программного обеспечения нуждается в структурированном и понятном описании. Поэтому качественная техническая документация для ПО — это не формальность, а стратегический актив вашего продукта. Она нужна для снижения ошибок, обеспечения жизнеспособности и развития проекта.
Разработка и сопровождение
Техдокументация необходима новым членам команды, чтобы понимать архитектуру, код и логику проекта. Она упрощает поддержку и доработку программного обеспечения.
Сдача ПО заказчику
Разработка технической документации — это финал процесса. Она демонстрирует соответствие готового продукта согласованным требованиям и техническим заданиям.
Регистрация ПО в Минцифры
Предоставление полного пакета технической документации — это обязательное требование для включения программ в реестр российского ПО. Если документы отсутствуют или не соответствуют требованиям, то в регистрации откажут.
Аудит и сертификация
Чтобы получить сертификаты соответствия, пройти разные формы аудитов, в том числе проверку по требованиям информационной безопасности, нужна техническая документация для программного обеспечения.
Эффективное использование
Руководство для пользователей и интеграторов, чтобы максимально эффективно использовать ваш продукт.
Что мы предлагаем
Подготовим необходимую техническую документацию, для дальнейшего использования при внедрении, продажи ПО клиентам, поддержку пользователей, разработчиков и партнеров.
Весь набор технической документации, определенной в перечне необходимых для регистрации программ для ЭВМ в реестр российского ПО Минцифры, также по желанию любые другие документы, такие как:
Спецификации и требования: Документы, описывающие функциональные и нефункциональные требования к программному продукту
Руководства по эксплуатации и администрированию: Инструкции для системных администраторов по установке, настройке и поддержке ПО
Сопровождающая документация: Протоколы тестирования, журналы изменений, FAQ и другие материалы для поддержки жизненного цикла ПО
этапы работы
Как мы подготовим для вас техническую документацию
Процесс максимально прозрачен и состоит из следующих этапов:
Подготовительные работы
- Анализ требований: изучим ваш продукт, целевую аудиторию и задачи документации
- Составление структуры: определим объём и план работ.
Написание и согласование:
- В процессе работы будем взаимодействовать с Вашими сотрудниками учитывая их особенности и специфику поведения
- Подготовим документацию, отформатируем её, добавим схемы, диаграммы и прочее, если это необходимо
- Предоставим Вам техническую документацию на согласование
- Устраним замечания с Вашей стороны, если они будут предоставлены.
Поддержка
- Предоставляем услуги по обновлению и дополнению документации при необходимости.
Принципы нашей работы
Каждый проект уникален, поэтому процесс работы будет построен на глубоком погружении в продукт и взаимодействии с командой ваших разработчиков, архитекторов и аналитиков:
Глубокий анализ
Изучаем исходный код, архитектуру, имеющиеся актуальные материалы, проводим интервью с вашими специалистами.
Структурирование
Приводим информацию к общепринятым стандартам (IEEE, ГОСТ, ISO).
Ясность и точность
Пишем понятным техническим языком.
Визуализация
Для наглядности используем схемы и скриншоты, диаграммы (UML, BPMN).
Соблюдение сроков
Разрабатываем согласованный комплект документов в установленные сроки.
Актуализация
Поддержание документации в актуальном состоянии после выхода новых версий продуктов.
Берем на себя успешную регистрацию
брендов, программ, технических решений
Ольга Бондарева
Патентный поверенный №2104
Надежда Рузавина
Патентный поверенный РФ № 2165, Юрист в области интеллектуальной собственности, IT и защиты персональных данных
Екатерина Наумова
Патентный поверенный РФ, Евразийский патентный поверенный, Кандидат технических наук
Сергей Пальчиков
Технический эксперт
Вячеслав Ананин
Патентный поверенный РФ №2490, Кандидат технических наук
Владимир Глыбин
Патентный поверенный РФ №2440
Запишитесь на видеоконференцсвязь с экспертом
Перед сотрудничеством и составлением коммерческого предложения обязательно проводится ВКС с заказчиком на предмет обсуждения нюансов сотрудничества, выяснения технических, правовых и организационных моментов.
Работаем индивидуально.
Готовы предложить полный комплекс услуг по написанию технической документации и включению ПО в Реестр российского программного обеспечения Минцифры (с учетом прохождения всех необходимых процедур в комплексе).
стоимость услуг
Стоимость внесение программы в реестр Минцифры
Окончательная стоимость формируется в зависимости от условий, таких как:
- Объем и сложность программного обеспечения: количество функций, модулей, интеграций.
- Состав пакета документации.
- Наличие исходных материалов: техзадание, черновые наброски, диаграммы.
- Необходимость реверс-инжиниринга: готовится ли документация по продукту «с нуля» или по готовому коду.
После ознакомления с вашим продуктом мы проводим предварительную оценку стоимости работ. Цена, закрепленная в договоре, не меняется.
Анализ исходной информации
о разработанном техническом решении, оценка возможности внесения в реестр Минцифры, а также подготовки технической документации
21 000 ₽
Срок анализа: 7 рабочих дней
Разработка технической документации
Вы получаете от 11 до 13 технических документов на ПО
от 350 000 ₽
1-2 календарных месяца, срок зависит от вида и сложности ПО, а также объема работы и наличия квалифицированных консультантов со стороны заказчика
ВНЕСЕНИЕ В РЕЕСТР МИНЦИФРЫ
Помощь при внесении ПО в реестр Минцифры. Контроль патентного поверенного и IT юриста
100 000 ₽
Срок внесения в реестр от 1,5 до 2 месяцев
Пример реализованных проектов
Провели регистрацию программы «Система прогнозирования и аналитики ДТП» в Минцифры
Зарегистрировали программу «ОПТИМА ВИДЕО» в реестре отечественного ПО
Зарегистрировали программный комплекс для создания колл-центра в реестре Минцифры
Зарегистрировали программный комплекс для контроллеров 8SMC
Зарегистрировали программный комплекс в реестре Минцифры для инновационной компании, занимающейся разработкой высокотехнологичных систем
Зарегистрировали программный комплекс PRO.FINANSY в реестре Минцифры
Зарегистрировали в реестре Минцифры программу для ЭВМ «Автодискавери. Оцифровка. Повышенная точность на основе ИИ»
Зарегистрировали в реестре Минцифры программный продукт «BNМАР PRO»
Зарегистрировали в реестре Минцифры ПЭВМ «Программно-аппаратный комплекс «Электронный доктор»
FAQ
Часто задаваемые вопросы
Да, мы можем оформить весь комплекс технической документации или только часть. Условия обсуждаются с каждым клиентом индивидуально.
Да, наши эксперты оказывают полный перечень услуг «под ключ». Мы поможем собрать весь пакет документов и направить заявку. Процесс займет около полутора месяцев. Будем сопровождать вас до момента регистрации. Подробнее здесь.
Минимальный пакет включает:
- техническое описание;
- руководство пользователя (инструкция по установке и использованию);
- документы, описывающие жизненный цикл ПО;
- документы, подтверждающие законность использования заимствованных фрагментов кода и российское происхождение ПО;
- демоверсия программы или ссылка для ее скачивания;
- документы, которые дают представление о техподдержке программного обеспечения/
Наши клиенты получают полный пакет документов, который полностью соответствует актуальным требованиям регулятора.
Да, конечно. Мы проводим реверс-инжиниринг документации по готовому коду. Наши технические писатели будут сотрудничать с вашими разработчиками, чтобы изучить архитектуру, функционал и восстановить полную картину проекта.
Помимо взаимодействия с вашими разработчиками, архитекторами и продукт-менеджерами нам понадобится доступ к
- демоверсии программного обеспечения, чтобы протестировать функции и сделать скриншоты;
- ТЗ и архитектурным диаграммам, если они есть;
- коду (желательно) для описания API, условий лицензии и сложных алгоритмов.
Подготовленный пакет документов будет полностью соответствовать требованиям регулятора по содержанию и оформлению. Наш IT-юрист поможет вам успешно пройти регистрацию в Минцифре.
Разработчики — это эксперты в коде. Технические писатели излагают сложную техническую информацию структурировано, логично и на понятном для целевой аудитории языке. Они досконально знают ГОСТы и требования Минцифры. Кроме того, разработчику это помогает сэкономить время.
Да, мы практикуем работу с гибкими подходами к документированию. В процессе наши технические писатели будут:
- обновлять документы параллельно со спринтами;
- использовать Confluence, Swagger для API и другие инструменты, интегрированные в вашу среду разработки;
- фокусироваться на документировании стабильных и завершенных функций.
Такой подход поможет постепенно наращивать объем готовой документации.
Блог о патентном праве
Статьи, информационные материалы, экспертное мнение
