ГОСТ 34. Шаблоны 7 основных документов. Бери и применяй!

Если нужна Заказчику документация по ГОСТ 34, то существует 7 основных документа:

- ТЗ — Техническое задание.

- ПЗ — Пояснительная записка или Описание системы.

- СР — Схема развертывания системы.

- API — Описание протокола взаимодействия с внешними системами.

- РА— Руководство системного администратора.

- РП — Руководство пользователя.

- ПМИ — Программа и методика испытаний.

Шаблоны документов

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

ТЗ — Техническое задание

Техническое задание создает сама компания-заказчик программного обеспечения. Она заказывает Исполнителю что ей надо и какой должна быть Система.

ПЗ — Пояснительная записка или Описание системы

Пояснительную записку создает компания-исполнитель.

В документе показано какую они Систему сделали для Заказчика и что она умеет делать.

СР — Схема развертывания системы

Документ для Системного администратора Заказчика, по нему администратор легко и быстро развернет Систему на своих серверах (это большие и мощные компьютеры).

API — Описание протокола взаимодействия с внешними системами

Документ для программистов, разработчиков Заказчика. Нужен для подключения своих систем к новой Системе, которую сделал Исполнитель.

РА— Руководство системного администратора

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

РП — Руководство пользователя

Документ для конечного пользователя Системы. Например, как пользоваться инженеру на заводе Системой учета металлопроката.

ПМИ — Программа и методика испытаний

Тут Исполнитель доказывает Заказчику что они Систему сделали точно такой как просил Заказчик в Техническом задании. Основные разделы заполняются по готовому шаблону и даются общие данные о Системе, их надо взять из Пояснительной записки.

Шаблоны можно скачать в уроках учебного курса Технический писатель - https://777text.getcourse.ru/page0