РУКОВОДСТВО СИСТЕМНОГО ПРОГРАММИСТА¶
(Наименование программы)¶
АННОТАЦИЯ¶
// Краткое описание документа и его целевой аудитории.
СОДЕРЖАНИЕ¶
// Перечень разделов документа.
1. ОБЩИЕ СВЕДЕНИЯ О ПРОГРАММЕ¶
1.1. Назначение и функции программы¶
1.2. Сведения о технических средствах¶
// Характеристики серверов, рабочих станций, сети.
1.3. Сведения о программных средствах¶
// Системное ПО, СУБД, утилиты, необходимые для работы.
2. СТРУКТУРА ПРОГРАММЫ¶
2.1. Составные части программы¶
// Модули, компоненты, библиотеки.
2.2. Связи между составными частями¶
// Логическая схема взаимодействия.
2.3. Связи с другими программами¶
// Внешние интерфейсы, обмен данными с другими системами.
3. НАСТРОЙКА ПРОГРАММЫ¶
3.1. Настройка на состав технических средств¶
// Драйверы, конфигурационные файлы, параметры оборудования.
3.2. Выбор функций¶
// Активация/деактивация модулей.
3.3. Настройка режимов работы¶
// Параметры производительности, логирование, расписания.
4. ПРОВЕРКА ПРОГРАММЫ¶
4.1. Способы проверки работоспособности¶
// Методика запуска диагностических тестов.
4.2. Контрольные примеры¶
// Наборы тестовых данных и ожидаемые результаты.
4.3. Результаты проверки¶
// Критерии успешного прохождения.
5. ДОПОЛНИТЕЛЬНЫЕ ВОЗМОЖНОСТИ¶
// Утилиты, скрытые функции, сервисные режимы. // Способы их вызова и использования.
6. СООБЩЕНИЯ СИСТЕМНОМУ ПРОГРАММИСТУ¶
6.1. Сообщения при настройке¶
// Текст, смысл, рекомендуемые действия.
6.2. Сообщения при проверке¶
// Текст, смысл, рекомендуемые действия.
6.3. Сообщения при выполнении программы¶
// Текст, смысл, рекомендуемые действия.
6.4. Диагностические коды¶
// Коды ошибок в журналах системы.
ПРИЛОЖЕНИЯ¶
// Тексты конфигурационных файлов, схемы взаимодействия.