Руководство системного программиста
Руководство системного программиста относится к эксплуатационно-технической документации. Документ предоставляет сведения для проверки, обеспечения функционирования и конфигурирования программы, если данные возможности обусловлены системным кодом ПО.
Во многих компаниях установка и глубокая настройка некоторых программ обычным пользователям запрещена. Данная работа входит в список обязанностей системного программиста, который проверяет логи, обеспечивает автоматическое резервное копирование данных, ведет статистику производительности и устраняет технические неполадки.
Все перечисленные функции отображаются в документе «Руководство системного программиста». Данный документ разрабатывается и оформляется в соответствии с нормативами ГОСТ 19.503-79, а также сопутствующими ГОСТ 19.101-77 (Виды программных документов) и ГОСТ 19.105-78 (Общие требования к программным документам).
Структура документа
Руководство системного программиста должно включать всю необходимую информацию, чтобы разработчик имел возможность настраивать и поддерживать функциональность программного обеспечения (системы). Типовая структура документа приведена в ГОСТ 19.503-79 и включает:
1. Общие сведения о программе.
- Описывается назначение и функции программы.
2. Структура программы.
- Составные части, компоненты, их связь и структура программы.
3. Настройка программы.
- Отображаются необходимые действия по настройке программы в конкретных условиях применения, с использованием примеров.
4. Проверка программы.
- Описываются способы проверки, которые устанавливают работоспособность программы;
5. Дополнительные возможности.
- Описание дополнительного функционала и разделов программы.
6. Сообщения системному программисту.
- Указываются тексты сообщений, которые выдаются во время проверки и настройки программы.
7. Приложения.
- Иллюстрации, графики, таблицы и примеры.
Содержание руководства
Если руководство разрабатывается на простую монолитную программу, то документ получается относительно необъемным. Однако крупные аппаратно-программные комплексы требуют описания каждого компонента, чтобы обеспечить их интеграцию, а также работоспособность со сторонним ПО.
В руководстве системного программиста излагают следующую информацию:
сфера использования и задачи ПО;
принципы действия;
системные требования;
описание процедуры установки компонентов;
инструкция по настройке ПО;
методы интеграции установленных программ с их копиями и сторонним ПО;
периодичность и методика контроля работоспособности;
методы и порядок обслуживания ПО;
методы решения вспомогательных задач;
работа в случаях аварийной ситуации.
В зависимости от типа программы и способа ее настройки также может включаться другая информация (интерфейс, утилиты командной строки, язык для скриптов и т.д.).