Т3_З16_Л12_Основные виды технической и технологической документации ИБ_26

1. МИНИСТЕРСТВО ЦИФРОВОГО РАЗВИТИЯ, СВЯЗИ И МАССОВЫХ КОММУНИКАЦИЙ РОССИЙСКОЙ ФЕДЕРАЦИИ Федеральное государственное бюджетное

образовательное
учреждение высшего образования
«Санкт – Петербургский государственный университет телекоммуникаций
им. проф. М.А. Бонч-Бруевича»
СТАНДАРТИЗАЦИЯ, СЕРТИФИКАЦИЯ И
ТЕХНИЧЕСКОЕ ДОКУМЕНТОВЕДЕНИЕ
Преподаватель Рожков А.И.
Санкт-Петербург 2026

2.

ТЕМА 3. Техническое
документоведение
Основные виды технической и технологической
документации
I
Виды
II
технической
документации
и
технологической
Стандарты оформления документов, регламентов,
протоколов по информационным системам

3. Виды технической и технологической документации

I
Виды технической и технологической
документации
Определение: Техническая документация –
это совокупность текстовых и графических
материалов, описывающих технический объект
или процесс на всех этапах его жизненного цикла.
Назначение: Обеспечение проектирования,
изготовления, эксплуатации, сопровождения и
модернизации объектов.

4.

Что такое техническая документация?
Для ПО и ИС: является составляющей проекта по созданию, внедрению,
сопровождению, модернизации и ликвидации информационной системы на
всем протяжении жизненного цикла.
Ключевое уравнение:
Продукт (ПО) = Программный код + Полноценная документация

5.

Классификация технической документации
(общая)
Конструкторская документация (КД):
•Чертежи, схемы, спецификации
Технологическая документация (ТД):
•Маршрутные и операционные карты, технологические
инструкции
Эксплуатационная документация (ЭД):
•Руководства пользователя, паспорта, инструкции по
эксплуатации
Ремонтная документация:
• Руководства по ремонту и техническому обслуживанию

6.

Классификация документации на программное
обеспечение
1. Пользовательская документация:
•Для кого: Конечный пользователь.
•Цель: Обучение и решение задач.
•Примеры: Руководство пользователя, справочная система,
quick start guide.
2. Технологическая (разработческая) документация:
•Для кого: Разработчики, тестировщики, DevOps.
•Цель: Сопровождение, модификация, интеграция.
•Примеры: Техническое задание (ТЗ), спецификации API,
описание архитектуры, комментарии в коде.

7.

Классификация документации на программное
обеспечение
3. Проектная (управленческая) документация:
•Для кого: Менеджеры проекта, заказчики, архитекторы.
•Цель: Управление проектом, фиксация решений.
•Примеры: План проекта, протоколы совещаний, отчеты,
описание требований (SRS).

8.

Функции технической документации для ИС
Описательная:
•Детализирует возможности, архитектуру и логику системы
Нормативная:
•Регламентирует процессы разработки, эксплуатации, защиты
информации и права доступа
Коммуникационная:
•Служит средством взаимодействия между заказчиком,
разработчиком и пользователем

9.

Функции технической документации для ИС
Обеспечивающая:
•Содержит информацию для развертывания, настройки,
обслуживания и модернизации системы
Юридическая:
•Фиксирует принятые решения и служит основанием для
приемки работ

10.

Основные требования к технической
документации
Основные требования к технической документации
• Точность и однозначность: Исключение двусмысленных трактовок;
• Полнота: Отражение всех необходимых аспектов системы;
• Актуальность:
Постоянное
изменениями в системе;
обновление
• Структурированность и наглядность:
использование схем, таблиц, диаграмм;
в
соответствии
Логичное
с
построение,
• Стандартизированность: Соблюдение установленных форм, правил
и ГОСТов;
• Краткость (лаконичность): Изложение
детализации, где это не требуется.
сути
без
излишней

11. Стандарты оформления документов, регламентов, протоколов по информационным системам

II
Стандарты оформления документов,
регламентов, протоколов по
информационным системам
Системы стандартов для
документирования ИС
ЕСПД (Единая система программной
документации, индекс «19»):
• Область:
Документация
программные средства.
на
• Ключевые ГОСТы: 19.101-77 (Виды
документов),
19.105-78
(Общие
требования).

12.

Системы стандартов для документирования ИС
ЕСКД (Единая система конструкторской документации, индекс «2»):
• Область: Документация на технические (аппаратные) компоненты
систем.
• Пример: ГОСТ 2.105-2019 (Требования к текстовым документам).
КСАС (Комплекс стандартов на автоматизированные системы,
индекс «34»):
• Область: Документация на комплексные автоматизированные
системы (АСУ, АСУ ТП), включающие и ПО, и технику.
• Ключевой ГОСТ: 34.201-2020 (Виды, комплектность и обозначение
документов).

13.

Ключевые документы программной
документации (по ЕСПД)
Техническое задание (ТЗ)
•Основной документ, определяющий цели, требования и
условия создания системы
Текст программы
•Исходный код с комментариями
Описание программы
•Логическая структура, алгоритмы, интерфейсы
Пояснительная записка
• Обоснование принятых проектных решений
Эксплуатационные документы
• Сведения о назначении и применении программы

14.

Ключевые документы эксплуатационной
документации
Описание применения
•Назначение, условия, входные/выходные данные
Руководство системного программиста
•Для установки, настройки и интеграции
Руководство программиста
•Для доработки и технического сопровождения
Руководство оператора
• Инструкции по ежедневной эксплуатации
Руководство пользователя
• Для решения задач с помощью системы
Формуляр (паспорт)
• Общие сведения и комплектность

15.

Стандарты по качеству и информационной
безопасности
Информационная безопасность
(при документировании):
Оценка качества документации:
• Базовые: ГОСТ Р 50922-2006
(Термины), ГОСТ Р 53114-2008
(Обеспечение ИБ).
• ГОСТ
Р
ИСО/МЭК
25041
(SQuaRE): Руководство по оценке
качества;
• Системные: ГОСТ Р ИСО/МЭК
27001 (СМИБ. Требования).
• ГОСТ 28195-89: Оценка качества
программных средств (в части
документации).
• Для
приложений:
ГОСТ
Р
ИСО/МЭК 27034-1 (Безопасность
приложений).

16.

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