Документация остаётся у вас
Исходники документов и права передаются вам. Правки можно вносить самим.
Услуга
Техническая документация на программное обеспечение
Программа работает, а описать её нечем: документации нет, права оформляются вслепую, новый разработчик входит месяцами. Собираем комплект документов, по которому продукт можно передать, поддержать и зарегистрировать.
Описание ПО
функции, модули, структура
Схема данных
алгоритмы и связи
Комплект документов
по составу и назначению
Для регистрации
материалы под Роспатент
3 причины описать продукт, пока он в работе
Обычно за документацию берутся перед регистрацией или передачей. К этому моменту продукт уже существует годами, и описать его — отдельная работа. Если описание есть заранее, всё остальное идёт по готовому.
Продукт перестаёт жить в голове разработчика
Описание остаётся у компании, а не уходит вместе с человеком. Новый специалист входит в проект по документам, а не по рассказам.
Передача без потерь
Продукт можно передать, продать или отдать на поддержку: есть что передавать — описание, структура, состав.
Регистрация проходит быстрее
Материалы для Роспатента не собираются заново: они уже описаны и согласованы между собой.
Дополнительно
- Требования заказчиков выполняются. Госзаказ, крупный заказчик или инвестор требуют документацию. Без неё продукт не принимают.
- Поддержка становится дешевле. Правки и доработки идут по описанию, а не по догадкам. Меньше времени на разбор чужого кода.
- Актив учитывается как следует. Нематериальный актив с документацией можно оценить, поставить на баланс и использовать как обеспечение.
6 составляющих комплекта документации
Состав зависит от того, для чего документация нужна: для передачи, для регистрации или для требований заказчика. Ниже — из чего обычно собирается комплект.
Описание программы
Назначение, область применения, функции и режимы работы. Языками и платформами: на чём написано, где работает, что требуется для запуска.
Структура и модули
Из чего состоит продукт, как связаны части, за что отвечает каждая. Схема, по которой понятно устройство без чтения кода.
Схема данных
Что хранится, в каком виде, как связано. Ключевые алгоритмы и логика обработки — в объёме, достаточном для понимания работы.
Руководства
Документы для пользователя и администратора: как работать с системой, как её настраивать и обслуживать.
Материалы для Роспатента
Реферат, идентифицирующие материалы, согласование с заявкой — если документация готовится под регистрацию.
Состав по вашему требованию
Если у вас есть требования заказчика, госзаказа или внутреннего стандарта — комплект собирается под них.
Стоимость и сроки
Стоимость
от 90 000 ₽
Зависит от объёма программы, состояния существующих описаний и состава комплекта. Если документация готовится под регистрацию — материалы согласуются с заявкой, чтобы не собирать их дважды.
Сроки
от 2 недель
Срок зависит от того, сколько нужно восстановить по коду. Если у команды есть описания и схемы — быстрее. Если продукт существует только в коде, потребуется время на разбор.
Точный состав и срок определяются после разбора продукта. Это короткий этап: смотрим код, существующие документы и требования, после чего видно объём.
Что в итоге
Не «папка документов», а описание, по которому продукт можно передать и защитить.
Согласовано с заявкой
Если документация идёт под регистрацию, материалы не противоречат друг другу.
Без шаблонов ради галочки
Комплект собирается под ваш продукт и задачу, а не под форму ради формальности.
2 вопроса перед заказом документации
Можно ли обойтись без документации? Технически — да, продукт работает. Но при передаче, регистрации, поддержке или требовании заказчика документация понадобится. Тогда её собирают в спешке, по факту, из кода и разговоров с теми, кто ещё помнит. Это дороже и дольше, чем описать продукт, пока он в работе.
С чего начать — с документа или с кода? С описания: сначала функции, структура и данные, потом документы по ним. Если начать с формы, документ получится противоречивым, и его придётся переписывать.