---

Стандарты оформления программной документации
(ГОСТ 19, ГОСТ 34)
1. ВВЕДЕНИЕ. РОЛЬ СТАНДАРТИЗАЦИИ В РАЗРАБОТКЕ ПО
Документация — это:
 юридическая основа взаимодействия с заказчиком (ТЗ);
 техническое описание для сопровождения и развития системы;
 руководство для пользователей и администраторов;
 источник информации для аудита и сертификации.
Зачем нужны ГОСТы?
В СССР и России действует система государственных стандартов,
которая унифицирует требования к документам. Это нужно для:
 единообразия — любой специалист, знакомый со стандартом, сможет
прочитать вашу документацию;
 взаимопонимания — заказчик, разработчик, тестировщик говорят на
одном языке;
 юридической силы — документы, оформленные по ГОСТ, имеют
статус официальных;
 снижения ошибок — стандарты содержат проверенные временем
лучшие практики.
Основные стандарты, которые мы рассмотрим:
1) ГОСТ 19 — единая система программной документации (ЕСПД)
2) ГОСТ 34 — автоматизированные системы (АС)
Эти стандарты дополняют друг друга: ГОСТ 34 описывает жизненный
цикл создания АС в целом, а ГОСТ 19 — конкретные требования к
программным документам.
2. ЕДИНАЯ СИСТЕМА ПРОГРАММНОЙ ДОКУМЕНТАЦИИ (ЕСПД).
ГОСТ 19
2.1. Общие положения
ГОСТ 19 — это комплекс стандартов, устанавливающих требования к
разработке, оформлению и эксплуатации программной документации.
Основные документы ЕСПД:
Номер ГОСТ Название Назначение
ГОСТ 19.101-77
Виды документов и
программ
Определяет, какие документы
вообще существуют
ГОСТ 19.102-77 Стадии разработки Определяет этапы создания ПО
ГОСТ 19.103-77 Обозначения документов Правила нумерации и кодирования
ГОСТ 19.104-78 Основные надписи Требования к титульным листам
ГОСТ 19.105-79
Общие требования к
документам
Базовые правила оформления
ГОСТ 19.106-79
Требования к документам,
разрабатываемым на стадии
эксплуатации
Документы для пользователей
ГОСТ 19.201-78 Техническое задание Структура и содержание ТЗ
ГОСТ 19.202-78 Спецификация Описание состава ПО
ГОСТ 19.301-79
Программа и методика
испытаний
Как тестировать ПО
ГОСТ 19.401-79 Пояснительная записка Описание разработки
ГОСТ 19.402-78 Описание программы Документ для программистов
ГОСТ 19.404-79 Руководство пользователя Инструкция для пользователей
ГОСТ 19.501-79 Руководство программиста Инструкция для разработчиков
ГОСТ 19.502-78 Руководство оператора Инструкция для операторов
ГОСТ 19.503-79 Описание применения Как применять ПО
ГОСТ 19.504-79 Описание сопровождения Как поддерживать ПО
ГОСТ 19.505-79 Формуляр Паспорт изделия
ГОСТ 19.601-78 Алгоритмы и программы Правила описания алгоритмов
2.2. Стадии разработки ПО по ГОСТ 19.102-77
Стандарт определяет следующие стадии:
1) Техническое задание (ТЗ) — формулирование требований
2) Эскизный проект — предварательная проработка (не всегда
применяется)
3) Технический проект — детальное проектирование
4) Рабочий проект — разработка рабочей документации
5) Внедрение — внедрение разработанного ПО
Для каждой стадии разрабатывается свой комплект документов.
2.3. Требования к оформлению документов (ГОСТ 19.105-79)
Основные требования:
Формат документов:
 основной формат — А4 (210×297 мм);
 допускается А3 для схем и чертежей;
 ориентация — книжная (для А4) или альбомная (для А3).
Поля:
 левое — не менее 20 мм (для подшивки);
 правое — не менее 10 мм;
 верхнее — не менее 15 мм;
 нижнее — не менее 20 мм.
Шрифт:
 высота букв и цифр — не менее 2.5 мм;
 рекомендуемый размер — 12-14 пт;
 шрифт — Times New Roman или аналогичный с засечками.
Абзацный отступ:
 12.5 мм (или 5 символов)
Межстрочный интервал:
 одинарный или полуторный.
Нумерация страниц:
 сквозная нумерация в правом нижнем углу;
 титульный лист включается в нумерацию, но номер на нём не ставится.
Заголовки разделов:
 прописными буквами;
 без точки в конце;
 отделяются от текста пустой строкой.
Пример оформления заголовка:
1 ОСНОВНЫЕ ПОЛОЖЕНИЯ
Текст раздела начинается с новой строки…
2.4. Структура Технического задания (ГОСТ 19.201-78)
ТЗ — это основной документ, с которого начинается разработка.
Обязательные разделы ТЗ:
1) Введение
 наименование и обозначение системы;
 основание для разработки (приказ, договор);
 плановые сроки начала и окончания работ.
2) Назначение и цели создания системы
 зачем создается система;
 какие задачи должна решать.
3) Характеристика объектов автоматизации
 описание предметной области;
 текущее состояние процессов;
 требования к системе;
 требования к функциям;
 требования к численности и квалификации персонала;
 показатели назначения;
 требования к надежности;
 условия эксплуатации;
 требования к составу и параметрам технических средств;
 требования к информационной совместимости;
 требования к защите информации;
 патентно-правовые требования;
 требования к маркировке и упаковке.
4) Состав и содержание работ по созданию системы
 этапы работ;
 сроки выполнения.
5) Порядок контроля и приемки системы
 виды испытаний;
 критерии приемки.
6) Требования к документированию
 перечень документов;
 требования к оформлению.
7) Источники разработки
 документы, на основании которых ведется разработка.
8) Приложения
 схемы, таблицы, рисунки.
3. АВТОМАТИЗИРОВАННЫЕ СИСТЕМЫ. ГОСТ 34
3.1. Общие положения
ГОСТ 34 — это комплекс стандартов, регулирующих создание
автоматизированных систем (АС).
Что такое автоматизированная система?
Согласно ГОСТ 34.003-90:
Автоматизированная система (АС) —
совокупность методов и средств,
объединенных в единый комплекс с целью
автоматизации решения задач определенной
предметной области.
Отличие от информационной системы:
ИС — более широкое понятие.
АС — ИС, в которой человек участвует в процессе обработки
информации.
Основные документы ГОСТ 34:
Номер ГОСТ Название Назначение
ГОСТ 34.003-90 Термины и определения Базовая терминология
ГОСТ 34.101-91 Виды, состав и обозначения Классификация документов
ГОСТ 34.201-90
Виды, состав и обозначения
документов при создании АС
Документы для АС
ГОСТ 34.601-90
Автоматизированные
системы. Стадии создания
Этапы создания АС
ГОСТ 34.602-89
Техническое задание на
создание АС
Структура ТЗ для АС
3.2. Стадии создания АС по ГОСТ 34.601-90
Этапы создания автоматизированной системы:
1) Формирование требований к АС (обследование объекта)
 изучение объекта;
 анализ информации;
 формирование требований.
2) Разработка концепции АС
 изучение объекта;
 проработка вариантов;
 выбор оптимального варианта.
3) Техническое задание
 разработка и утверждение ТЗ.
4) Эскизный проект (при необходимости)
 предварительные решения.
5) Технический проект
 проектирование структуры АС;
 разработка технических решений;
 разработка документации.
6) Рабочая документация
 внедрение в проект решений технического проекта;
 разработка или адаптация ПО;
 комплектация АС.
7) Внедрение АС
 подготовка объекта;
 подготовка персонала;
 пусконаладочные работы;
 проведение испытаний.
8) Сопровождение АС
 гарантийное обслуживание;
 постгарантийное обслуживание.
3.3. Техническое задание на создание АС (ГОСТ 34.602-89)
Структура ТЗ на создание АС:
Общие сведения
 полное наименование АС
 краткая характеристика объекта автоматизации
 основание для разработки
 плановые сроки
Назначение и цели создания АС
 назначение АС
 цели создания (повышение эффективности, снижение затрат и т.д.)
Характеристика объекта автоматизации
 краткое описание объекта
 сведения об условиях эксплуатации
 описание существующих процессов
Требования к АС
 требования к функциям АС
 требования к численности и квалификации персонала
 показатели качества АС
 требования к надежности
 условия эксплуатации
 требования к составу и параметрам технических средств
 требования к информационной совместимости
 требования к защите информации
 патентно-правовые требования
 требования к маркировке и упаковке
Состав и содержание работ по созданию АС
 перечень этапов
 сроки выполнения
 ответственные исполнители
Порядок контроля и приемки АС
 виды испытаний
 критерии приемки
 состав приемочной комиссии
Требования к составу и содержанию документации
 перечень документов
 требования к оформлению
Источники разработки
 нормативные документы
 техническая литература
 аналогичные системы
Приложения
 схемы, чертежи, таблицы
3.4. Сравнение ГОСТ 19 и ГОСТ 34
Критерий ГОСТ 19 (ЕСПД) ГОСТ 34 (АС)
Область
применения Программные продукты Автоматизированные системы
Фокус
Программная
документация
Комплексная документация на
систему
Объем ТЗ Более детально о ПО
Более широко о системе в
целом
Типовые
документы ТЗ, ПЗ, РП, РПольз ТЗ, ТП, РД
Когда применять
Разработка отдельного
ПО Создание комплексной АС
Важно: На практике часто применяют оба стандарта одновременно.
ГОСТ 34 задает общую структуру проекта, а ГОСТ 19 детализирует
требования к программным компонентам.
4. СТРУКТУРА И СОДЕРЖАНИЕ ОСНОВНЫХ ДОКУМЕНТОВ
4.1. Техническое задание (ТЗ)
ТЗ — это юридический документ, определяющий требования к
разрабатываемой системе.
Ключевые разделы ТЗ:
1. Введение
1.1. Полное наименование системы:
"Автоматизированная система учета складских операций"
1.2. Обозначение темы: АС-2024-001
1.3. Основание для разработки:
Договор №123 от 01.01.2024 между ООО "Заказчик" и ООО
"Разработчик"
1.4. Плановые сроки начала и окончания работ:
- Начало: 01.02.2024
- Окончание: 30.06.2024
2. Назначение и цели создания системы
2.1. Назначение системы:
Автоматизация процессов учета поступления, хранения и отгрузки
товаров на складе ООО "Заказчик"
2.2. Цели создания системы:
- Сокращение времени обработки заказов на 40%
- Снижение количества ошибок при учете товаров на 80%
- Обеспечение основного контроля остатков товаров
3. Требования к системе
3.1. Требования к функциям:
Система должна обеспечивать:
- Приемку товаров с формированием приходных накладных
- Размещение товаров по ячейкам хранения
- Формирование заданий на отбор товаров
- Отгрузку товаров с формированием расходных накладных
- Инвентаризацию остатков
- Формирование отчетов по движению товаров
3.2. Требования к надежности:
- Среднее время безотказной работы: не менее 720 часов
- Время восстановления после сбоя: не более 2 часов
- Коэффициент готовности: не менее 0.98
3.3. Требования к защите информации:
- Разграничение доступа пользователей по ролям
- Шифрование паролей пользователей
- Протоколирование всех действий пользователей
- Резервное копирование данных каждые 24 часа
4.2. Пояснительная записка (ПЗ)
ПЗ — это основной документ, описывающий разработанную систему.
Структура ПЗ по ГОСТ 19.401-79:
1) Введение
 наименование программы
 основание для разработки
 плановые сроки
2) Назначение программы
 область применения
 технические характеристики
3) Описание задачи
 постановка задачи
 математическая модель
 алгоритм решения
4) Описание программы
 структура программы
 описание модулей
 используемые технические средства
5) Входные и выходные данные
 формат входных данных
 формат выходных данных
 примеры данных
6) Требования к программе
 требования к функциональному составу
 требования к надежности
 условия эксплуатации
7) Технические требования
 требования к техническим средствам
 требования к информационному обеспечению
8) Экономические показатели
 затраты на разработку
 эффективность внедрения
4.3. Руководство пользователя
Структура руководства пользователя по ГОСТ 19.502-78:
1) Назначение программы
2) Условия применения
3) Описание задачи
4) Описание программы
5) Входные данные
6) Выходные данные
7) Последовательность решения задачи
 подготовка к работе
 выполнение программы
 обработка результатов
8) Сообщения оператору
 типовые сообщения
 действия при ошибках
Пример раздела "Последовательность решения задачи":
5.1. Подготовка к работе
Перед началом работы необходимо:
а) Убедиться, что компьютер соответствует минимальным требованиям:
 - Операционная система: РЕДОС 7.3 или выше
 - Процессор: Intel Core i3 или аналогичный
 - Оперативная память: не менее 4 ГБ
 - Свободное место на диске: не менее 500 МБ
б) Запустить программу:
 - Открыть терминал
 - Перейти в каталог установки: cd /opt/warehouse-system
 - Выполнить команду: ./start.sh
в) Дождаться появления окна авторизации
5.2. Авторизация пользователя
а) В поле "Логин" ввести имя пользователя
б) В поле "Пароль" ввести пароль
в) Нажать кнопку "Войти" или клавишу Enter
Примечание: При трех неудачных попытках входа учетная запись
блокируется на 15 минут.
4.4. Программа и методика испытаний
Структура документа по ГОСТ 19.301-79:
1. Общие положения
1.1. Настоящая программа и методика испытаний (ПМИ) устанавливает
состав, объем и порядок проведения испытаний программы "Система учета
складских операций" (обозначение АС-2024-001-ПМИ).
1.2. Испытания проводятся с целью проверки соответствия программы
требованиям технического задания АС-2024-001-ТЗ.
2. Методы испытаний
2.1. Функциональные испытания
Проводятся путем выполнения типовых сценариев использования системы с
проверкой результатов.
2.2. Нагрузочные испытания
Проводятся путем создания нагрузки, имитирующей пиковую интенсивность
работы (100 одновременных пользователей).
2.3. Испытания на надежность
Проводятся путем непрерывной работы системы в течение 72 часов с
периодическим контролем состояния.
3. Требования к программе
3.1. Программа должна быть представлена в виде исполняемых файлов
и исходных кодов.
3.2. Программа должна сопровождаться документацией:
- техническое задание
- пояснительная записка
- руководство пользователя
- руководство программиста
4. Состав и содержание испытаний
4.1. Проверка функциональных возможностей
№ Проверяемая функция Метод проверки Критерий успеха
1
Создание приходной
накладной
Ввод тестовых
данных
Накладная создана,
данные сохранены
2 Поиск товара по артикулу Ввод артикула
Товар найден,
данные отображены
3 Формирование отчета Выбор периода
Отчет сформирован
за указанный период
4.2. Проверка надежности
Система должна работать непрерывно в течение 72 часов без сбоев.
Контроль состояния осуществляется каждые 4 часа.
5. ПРАКТИЧЕСКИЕ АСПЕКТЫ ОФОРМЛЕНИЯ В LIBREOFFICE
WRITER
5.1. Настройка стилей для ГОСТовского оформления
Создание стилей в LibreOffice Writer:
Шаг 1: Открытие окна стилей
Меню: Стили → Управление стилями (F11)
Или: боковая панель → Стили
Шаг 2: Создание стиля "Заголовок 1"
Параметры стиля:
- Шрифт: Times New Roman
- Размер: 16 пт
- Начертание: полужирное
- Выравнивание: по центру
- Регистр: все прописные
- Интервал до: 12 пт
- Интервал после: 12 пт
- Нумерация: автоматическая (1, 2, 3...)
Шаг 3: Создание стиля "Основной текст"
Параметры стиля:
- Шрифт: Times New Roman
- Размер: 14 пт
- Выравнивание: по ширине
- Межстрочный интервал: 1.5
- Абзацный отступ: 12.5 мм (первая строка)
- Интервал до: 0 пт
- Интервал после: 0 пт
Шаг 4: Создание стиля "Листинг кода"
Параметры стиля:
- Шрифт: Courier New (моноширинный)
- Размер: 12 пт
- Выравнивание: по левому краю
- Межстрочный интервал: одинарный
- Отступ слева: 10 мм
- Рамка: тонкая линия
5.2. Настройка полей и колонтитулов
Настройка полей:
 Меню: Формат → Страница → вкладка "Страница"
 Формат: A4
 Ориентация: книжная
 Поля:
левое: 20 мм
правое: 10 мм
верхнее: 15 мм
нижнее: 20 мм
Настройка колонтитулов:
 Меню: Вставка → Колонтитул → Верхний/Нижний
 В нижнем колонтитуле:
Выравнивание по правому краю
Вставка → Поля → Номер страницы
Формат: "Страница X из Y"
5.3. Автонумерация разделов
Настройка автоматической нумерации:
 Меню: Сервис → Параметры → LibreOffice Writer → Нумерация
 Или: Стили → Управление стилями → Список
Пример настройки:
Уровень 1: 1, 2, 3... (разделы)
Уровень 2: 1.1, 1.2, 1.3... (подразделы)
Уровень 3: 1.1.1, 1.1.2... (пункты)
Применение к заголовкам:
Стиль "Заголовок 1" → Уровень 1
Стиль "Заголовок 2" → Уровень 2
Стиль "Заголовок 3" → Уровень 3
5.4. Формирование оглавления
Вставка оглавления:
 Меню: Вставка → Оглавление и указатель → Оглавление или
указатель
 Тип: Оглавление
 Уровни: 3 (или нужное количество)
 Создание из: Структуры документа
Обновление оглавления:
Правый клик на оглавлении → Обновить индекс/оглавление
5.5. Нумерация рисунков и таблиц
Нумерация рисунков:
 Вставка → Подпись
 Категория: Рисунок
 Формат: "Рисунок 1", "Рисунок 2"...
 Позиция: ниже изображения
Нумерация таблиц:
 Вставка → Подпись
 Категория: Таблица
 Формат: "Таблица 1", "Таблица 2"...
 Позиция: выше таблицы
Формирование списка рисунков/таблиц:
 Вставка → Оглавление и указатель → Оглавление или указатель
 Тип: Указатель иллюстраций
 Категория: Рисунок или Таблица
5.6. Создание шаблона документа
Сохранение как шаблон:
 Файл → Шаблоны → Сохранить как шаблон
 Имя: "ГОСТ_19_Шаблон"
 Категория: Мои шаблоны
 Формат: .ott (OpenDocument Template)
Использование шаблона:
 Файл → Создать → Шаблоны
 Выбрать: "ГОСТ_19_Шаблон"
 Создать новый документ на основе шаблона
5.7. Практические советы
1. Используйте стили, а не прямое форматирование
Неправильно: выделить текст → изменить шрифт вручную
Правильно: применить стиль "Основной текст"
2. Настраивайте автозамену для частых символов
Сервис → Параметры → Автозамена
Примеры:
"тз" → "техническое задание"
"пз" → "пояснительная записка"
"рис." → "рисунок"
3. Используйте перекрестные ссылки
Вставка → Перекрестная ссылка
Для ссылок на рисунки, таблицы, разделы
Автоматическое обновление при изменении нумерации
4. Применяйте разрывы разделов
Вставка → Разрыв → Разрыв раздела
Для изменения нумерации страниц
Для разного оформления колонтитулов
5. Сохраняйте в формате ODF
Формат ODF (.odt) — открытый стандарт
Совместимость с LibreOffice
Возможность конвертации в PDF
ЗАКЛЮЧЕНИЕ
Ключевые моменты:
1) ГОСТ 19 (ЕСПД) — стандарты для программной документации
 Определяет виды документов
 Устанавливает стадии разработки
 Регламентирует оформление
2) ГОСТ 34 — стандарты для автоматизированных систем
 Описывает жизненный цикл АС
 Определяет состав документации
 Регламентирует создание комплексных систем
3) Основные документы:
 Техническое задание (ТЗ) — требования к системе
 Пояснительная записка (ПЗ) — описание разработки
 Руководство пользователя — инструкция для пользователей
 Программа и методика испытаний — как тестировать
4) Практическое применение в LibreOffice:
 Настройка стилей для ГОСТовского оформления
 Автонумерация разделов, рисунков, таблиц
 Формирование оглавления и указателей
 Создание шаблонов документов