Разработка комплекта документации на программное обеспечение

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

К основным стандартам и ГОСТ, предъявляющим требования к документации на ПО, относятся ГОСТ Р ИСО/МЭК 12207-2010, ГОСТ 19-й серии.

RTM Group предлагает комплекс услуг по разработке комплекта документации на программное обеспечение, начиная с анализа требований заказчика и заканчивая созданием готового комплекта документации, соответствующего всем требованиям международных стандартов и ГОСТ РФ.

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

1. IT-компаниям, которые разрабатывают новые продукты и хотят обеспечить своих клиентов качественной документацией
2. Командам разработчиков, создающим крупные проекты с обширной документацией
3. Корпорациям и предприятиям, использующим сложные программные решения и нуждающимся в подробной документации для их эффективного использования
4. Отдельным специалистам или командам, работающим над собственными проектами и нуждающимся в профессиональной помощи в разработке документации
5. Образовательным учреждениям, обучающим студентов и преподавателей работе с программным обеспечением и использующим качественную документацию в учебном процессе
6. Государственным организациям и ведомствам, внедряющим новые программные системы и нуждающимся в разработке инструкций и руководств по их использованию
7. Инвесторам и аналитикам, которым требуется подробная и понятная документация для оценки и анализа программного обеспечения
8. Руководителям и менеджерам проектов, стремящимся обеспечить успешное выполнение проектов и эффективность работы команд с помощью качественной и понятной документации

Основная цель разработки документации для ПО

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

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

Этапы проведения работ при подготовке документов для ПО

Основные этапы разработки комплекта документации на ПО (количество этапов может варьироваться в зависимости от специфики проекта):

1. Утверждение перечня разрабатываемого комплекта документов на ПО для каждой стадии жизненного цикла ПО и фиксирование состава документов на этапе подписания договора
2. Определение степени детализации описания, формата документов, срочности разработки, стадии и готовности проекта, количества и качества существующих документов, наличия утвержденных ТЗ и ЧТЗ на ПО
3. Разработка документации, описывающей процессы разработки ПО, рабочую среду разработки, может включать в себя, например, функциональную спецификацию, спецификацию требований пользователя, описание архитектуры ПО
4. Обеспечение создания технической документации, включая создание документации API (пример документации API — руководство API, варианты кода использования API в программе), а также документации согласно ГОСТ 19-й серии, например, текст программы, описание программы
5. Согласование с заказчиком видов тестирования программного обеспечения и состава документации по тестированию: техническая документация тестирования программного обеспечения, проектная документация тестирования, документация проведения тестирования, описание ожидаемых результатов к тестовой документации в тестировании
6. Разработка руководств для эффективного использования ПО: руководство оператора, руководство программиста, руководство пользователя, руководство по техническому обслуживанию, инструкции настройки и установки и т.д.
7. Разработка документации по ИБ для безопасной разработки ПО согласно ГОСТ 56939-2016 Защита информации Безопасная разработка программного обеспечения
8. Создание инструкций, руководств и обучающих материалов для пользователей, описание процессов обновления и сопровождения ПО, разработка процедур реагирования на возникающие проблемы и запросы пользователей
9. Создание описания продукта с обозначением его преимуществ в сравнении с конкурентами для продвижения продукта и привлечения потенциальных клиентов и, соответственно, для увеличения продаж продукта
10. Согласование и утверждение с заказчиком финального комплекта документов

Ход проведения работ при разработке документов для программного обеспечения

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

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

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

Для оказания услуги необходима следующая информация и материалы:

1. Техническое задание на разработку ПО
2. Исходный код ПО
3. Требования к документации (содержание, оформление, структура и т. д.)
4. Сроки выполнения работ
5. Бюджет на разработку документации
6. Контактные данные для связи (адрес электронной почты, телефон)

Сроки создания документации для ПО

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

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

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

При разработке полного комплекта документации на ПО команда RTM Group проводит активное общение с заказчиком для уточнения требований, пожеланий, а также для контроля процесса разработки.

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

Дополнительные виды услуг в рамках разработки комплекта документов на ПО

• Безопасная разработка приложений является неотъемлемой частью общего процесса разработки ПО и требует расширенного пакета документов, который также может быть подготовлен RTM Group в соответствии с ГОСТ Р ИСО/МЭК 15408, ГОСТ Р ИСО/МЭК 18045-2013, ГОСТ Р 58412-2019, ГОСТ Р 56939-2016, ГОСТ Р 57628-2017 и др.

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

• Эксперты также могут провести проверку ПО на соответствие требованиям безопасности, провести тестирование на проникновение и предоставить заключение о соответствии уровню доверия.
• Мы дополнительно предлагаем разработку комплекта документации для систем ИИ с использованием ГОСТ 34-й серии, ГОСТ Р ИСО/МЭК 12207-2010 и других, который обеспечит полный цикл создания и сопровождения системы, от определения требований до поддержки и обновления.

Услуга разработки комплекта документов для искусственного интеллекта включает следующие этапы:

1. Определение с заказчиком целей и задач, которые должна выполнять система ИИ и которым должна соответствовать разработка системы ИИ, а также основные требования к ее работе
2. Разработка технического задания на основе согласованных требований, которое определяет структуру, функции, виды систем ИИ и требования к ним
3. Оформление документов, которые включают в себя различные формы, инструкции, руководства и другие документы, необходимые для работы с искусственным интеллектом
4. Помощь в процессе регистрации системы искусственного интеллекта ИИ в некоторых юрисдикциях
5. Обучение и тестирование системы ИИ и проверка работы системы ИИ на соответствие техническому заданию и требованиям заказчика. Важно заметить, что экспертная система ИИ может быть протестирована только пользователем-экспертом конкретной области применения данной системы (медицина, финансы, юриспруденция и других). Информационная система ИИ тестируется как обычная информационная система
6. Поддержка и обновление документации в соответствии с изменениями в требованиях и технологиях

Почему RTM Group?

• RTM Group имеет опыт разработки качественной технической документации согласно стандартам и ГОСТ, в том числе ГОСТ 19-й серии и ГОСТ Р ИСО/МЭК 12207-2010.
• RTM Group активно участвует в разработках, направленных на повышение качества и безопасности программного обеспечения.
• RTM Group имеет большой опыт в проведении тестов программного обеспечения с использованием различных методов тестирования, таких как функциональное тестирование, нагрузочное тестирование, тестирование безопасности, а также участвует в разработках тестовых сценариев.
• RTM Group имеет богатый опыт аудитов на соответствие требованиям безопасной разработки программного обеспечения.
• Мы обладаем лицензиями:
  • Лицензия ФСТЭК России на деятельность по технической защите конфиденциальной информации
  • Лицензия ФСТЭК России на деятельность по разработке и производству средств защиты конфиденциальной информации
  • Лицензия ФСБ России на работу со средствами криптозащиты