---

# Конспект: Документирование ПО в соответствии с ЕСПД

## 1. Виды документации в процессе разработки
Документация при создании программных средств (ПС) делится на две большие группы:

**1.1. Документы управления разработкой**  
Обеспечивают связи внутри команды и с менеджерами. Типы:
- Планы, оценки, расписания — для прогнозирования и управления процессами.
- Отчёты об использовании ресурсов.
- Стандарты — принципы и правила для разработчиков (международные, национальные или внутренние).
- Рабочие документы — фиксация идей, проблем, стратегий, черновые версии итоговых документов.
- Заметки и переписка — детали взаимодействия менеджеров и разработчиков.

**1.2. Документы, входящие в состав ПС (продуктовая документация)**  
Описывают программы для пользователей, разработчиков и сопровождающих. Используются на всех стадиях. Делятся на:
- Пользовательская документация (П-документация).
- Документация по сопровождению (system documentation).

---

## 2. Пользовательская документация
Объясняет, как применять ПС. Не касается модификации программ. Ориентирована на две аудитории:

- **Ординарный пользователь** (end-user) — решает прикладные задачи, может не знать деталей работы компьютера.
- **Администратор** — управляет правами доступа, поддерживает связь с поставщиками, поддерживает работоспособность ПС без изменения кода.

**Типовой состав для больших ПС:**
1. **Общее функциональное описание** — краткая характеристика возможностей для принятия решения о необходимости ПС.
2. **Руководство по инсталляции** — для администраторов: описание носителя, файлов, минимальных требований к аппаратуре.
3. **Инструкция по применению** — для ординарных пользователей, построена для последовательного изучения.
4. **Справочник по применению** — для ординарных пользователей, организован для быстрого поиска отдельных деталей.
5. **Руководство по управлению** — для администраторов: описание сообщений при взаимодействии с другими системами, действия при обслуживании системной аппаратуры.

**Ключевой момент:** качество пользовательской документации определяет успех ПС. К окончательному оформлению часто привлекают технических писателей. Разработка начинается сразу после создания внешнего описания.

---

## 3. Документация по сопровождению (system documentation)
Описывает ПС с точки зрения разработки. Необходима для изучения внутреннего устройства и модернизации программ. Сопровождение рассматривается как продолжающаяся разработка, поэтому команда сопровождения работает с документацией, созданной основными разработчиками.

Документация делится на две группы:

**3.1. Итоговые документы технологических этапов разработки:**
- Внешнее описание ПС (требования).
- Описание архитектуры системы с внешними спецификациями подсистем.
- Для каждой подсистемы — описание модульной структуры и внешние спецификации модулей.
- Для каждого модуля — спецификация и описание строения.
- Тексты модулей на языке программирования.
- Документы установления достоверности (проверки) — схемы тестирования, комплекты тестов, результаты других видов верификации.

**3.2. Документы, помогающие вносить изменения:**
- **Руководство по сопровождению** — описывает особенности реализации (преодолённые трудности), учтённые возможности развития, аппаратно- и программно-зависимые части. Фиксирует связи и зависимости между документами для поддержания согласованности при изменениях (желательно вести в базе данных управления конфигурацией).

---

## 4. Классификация стандартов ЕСПД (ГОСТ 19)
Группы стандартов Единой системы программной документации:
- **0** — Общие положения
- **1** — Основополагающие стандарты
- **2** — Правила выполнения документации разработки
- **3** — Правила выполнения документации изготовления
- **4** — Правила выполнения документации сопровождения
- **5** — Правила выполнения эксплуатационной документации
- **6** — Правила обращения программной документации
- **7, 8** — Резервные группы
- **9** — Прочие стандарты

**Обозначение стандарта ЕСПД:**  
`19.К-ГГ`, где  
`19` — класс стандартов ЕСПД,  
`К` — код группы (цифра из классификации),  
`ГГ` — две последние цифры года регистрации.  
Например: ГОСТ 19.401-78 (текст программы, требования к содержанию и оформлению).