как описывать архитектуру и требования к программному обеспечению
Технический проект — это один из ключевых результатов стадии проектирования автоматизированной системы (АС) согласно ГОСТ 34.201–89. Он представляет собой комплект проектных документов, в котором системная идея получает инженерную формализацию: определяется архитектура, устанавливаются требования к программному обеспечению, фиксируются принятые технические решения и организация создания системы.
Состав и оформление технического проекта регламентированы ГОСТ 34.603–92. Документация может быть дополнительно усилена и структурирована с учётом положений международных стандартов, таких как IEEE 830(Software Requirements Specification), ISO/IEC/IEEE 42010 (System and Software Architecture Description), ISO/IEC 25010 (качество программных продуктов).
Комплект документов технического проекта предназначен не только для соответствия формальным требованиям нормативной базы. Он играет практическую роль в управлении жизненным циклом системы и обеспечивает:
согласование архитектурных решений до начала затрат на разработку;
формализацию границ системы и интерфейсов между компонентами;
подготовку к внедрению, сертификации, передаче и сопровождению;
документационную базу для тендеров, аудита и масштабирования.
В соответствии с ГОСТ 34.201–89, технический проект включает целый набор документов. Центральным текстовым документом является пояснительная записка к техническому проекту. Её структура детализирована в РД 50-34.698–90 и охватывает все основные проектные аспекты: архитектуру, функциональность, технические средства, программное обеспечение и организацию работ.
Пояснительная записка — основной текстовый документ стадии технического проекта, включаемый в комплект проектной документации согласно ГОСТ 34.201–89.
Общие положения
Наименование проектируемой автоматизированной системы;
Обозначения и номера оснований для разработки (ТЗ, договоры, приказы);
Перечень организаций-участников и сроки выполнения;
Назначение системы и цели её создания;
Сфера применения, ограничения и нормативно-техническая база;
Сведения о предшествующих разработках, НИР и прототипах;
Очерёдность создания и стадийность работ.
Описание процесса деятельности
Состав процедур (операций), подлежащих автоматизации;
Взаимосвязь автоматизированных и неавтоматизированных процессов;
Требования к организации функционирования системы в рабочей среде.
Смотрите также: Назначение программы: как описывать и почему это важно в проектной документации.
Основные технические решения
Архитектура системы и структура подсистем;
Решения по информационному обмену и взаимодействию компонентов;
Взаимодействие с внешними и смежными системами, обеспечение совместимости;
Режимы функционирования, включая запуск, остановку и диагностику;
Комплекс технических средств и особенности размещения на объекте;
Персонал: численность, квалификация, распределение функций;
Состав функций и задач, реализуемых системой;
Состав и структура программного обеспечения, методы реализации, используемые языки и алгоритмы;
Форматы данных, объёмы, носители, маршруты обработки и обмена;
Меры по обеспечению надёжности, отказоустойчивости, защиты информации и соответствия требованиям.
Мероприятия по подготовке объекта автоматизации
Приведение информации к виду, пригодному для обработки на ЭВМ;
Обучение и проверка квалификации персонала;
Создание необходимых подразделений и рабочих мест;
Изменения в объекте автоматизации;
Иные мероприятия, связанные со спецификой внедряемой системы.
Технико-экономическое обоснование (при необходимости или в составе отдельного документа)
Оценка затрат на разработку и внедрение;
Расчёт экономической эффективности;
Оценка сроков окупаемости проекта.
Приложения
Включают, при необходимости:
Архитектурные и функциональные схемы;
Таблицы распределения функций;
Форматы входных и выходных документов;
Перечни компонентов;
Иллюстрации, поясняющие структуру, интерфейсы, взаимодействия.
Пояснительная записка — центральный, но не единственный документ стадии «Технический проект». Весь комплект документации на этой стадии формируется согласно ГОСТ 34.201–89 и РД 50-34.698–90, и включает организационные, технические, графические и финансово-сметные документы, оформляемые отдельно.
Ниже приведены основные документы, не входящие в состав пояснительной записки, но включаемые в комплект ТП:
Архитектурные и функциональные схемы
Схема функциональной структуры (подсистемы, функции, потоки);
Схема структурного деления и взаимодействий;
Чертежи компоновки, подключения и размещения оборудования;
Схемы автоматизации, подключения и проводок.
Эти документы визуализируют архитектуру, состав и связи компонентов.
Описание автоматизируемых функций и постановка задач
Документ «Описание автоматизируемых функций» (функции, цели, модели);
Документ «Описание постановки задач» (вход/выход, периодичность, взаимодействие).
Даёт логическую детализацию задач, реализуемых системой.
Программа и методика испытаний
Цели и объекты проверок;
План этапов, критерии и способы контроля;
Отчётность, порядок завершения и состав комиссий.
Обязательна при сдаче работ или приёме на опытную/промышленную эксплуатацию.
Организационно-распорядительные документы
План-график работ (этапы, сроки, исполнители);
Приказы, акты, протоколы, решения комиссий.
Обеспечивают управляемость, формализуют взаимодействие сторон и контроль прогресса.
Эксплуатационные и сопроводительные документы
Ведомость эксплуатационных документов;
Паспорт системы и формуляр;
Руководства пользователя и инструкции по эксплуатации.
Используются на этапе внедрения и поддержки системы.
Экономическая и надёжностная документация
Локальная смета и сметный расчёт;
Проектная оценка надёжности системы (по методике);
Технико-экономическое обоснование (при необходимости).
Формируют финансово-организационную основу проекта и оценивают эффективность.
Прозрачность проекта — понятная архитектура и зоны ответственности.
Управляемость изменений — фиксированная точка отсчёта при доработках.
Аргументированное принятие решений — обоснования стеков, технологий, рисков.
Готовность к сопровождению — есть вся информация для поддержки и масштабирования.
Соответствие требованиям — важно при сертификации и госконтрактах.
Если вы хотите внедрить или адаптировать структуру проектной документации под ваш проект:
мы поможем определить оптимальную глубину и формат описания;
предоставим шаблоны и рекомендации под ГОСТ, ISO, IEEE;
поддержим команду при внедрении и сопровождении;
поможем сформировать архитектурные артефакты, необходимые для тендеров, сертификации и сопровождения.
Свяжитесь с нами — мы поможем сделать документацию источником устойчивости, а не формальностью.
10.05.2025