Руководство системного администратора составляют на основании ГОСТ 19.503-79
Руководство системного администратора — программный документ, предоставляющий специалисту информацию, необходимую для выполнения работы по установке программ и поддержанию работоспособности всего программного обеспечения, используемого в рамках тех или иных систем.
Руководство системного администратора — вспомогательный документ для прикладных программных продуктов и основной для серверных и системных, которые не имеют непосредственных пользователей.
В руководстве системного администратора должны быть изложены:
– назначение и область применения программы;
– состав программы, основные принципы ее функционирования;
– комплект поставки (если он не указан в отдельном документе);
– системные требования для программы или ее компонентов;
– предпочтительная очередность установки компонентов;
– процедура установки программы или каждого ее компонента;
– порядок обязательной первоначальной настройки программы;
– способы интеграции установленных копий компонентов между собой;
– интегрирование программы со сторонним ПО, например, с сервером БД;
– способы и периодичность контроля правильности работы программы;
– порядок текущего обслуживания работающих копий программы;
– порядок решения всевозможных вспомогательных задач;
– аварийные ситуации и способы их устранения.
Дополнительно в руководстве системного администратора можно описать:
– пользовательский интерфейс административной консоли;
– утилиты командной строки и синтаксис их запуска;
– конфигурационные файлы и правила их написания;
– язык для составления управляющих скриптов.
Структура руководства системного программиста имеет вид:
1. Общие сведения о программе.
2. Архитектура и принципы функционирования.
3. Системные требования.
4. Установка программы.
5. Административная консоль и работа с ней.
6. Файл конфигурации. Составление и правка.
7. Обязательная начальная настройка программы.
8. Проверка правильности функционирования программы.
9. Мероприятия по текущему обслуживанию программы.
10. Оптимизация работы программы.
11. Аварийные ситуации и способы их устранения.
В качестве примера приведено содержание руководства системного администратора для программы ТурбоБухгалтер 6.5. Сетевая версия.
ТурбоБухгалтер — одна из наиболее популярных в нашей стране программ автоматизации бухгалтерского учета. Сетевая версия программы позволяет организовать совместную работу нескольких бухгалтеров с общим набором данных. Клиент-серверная архитектура и применение протокола TCP/IP для обмена данными между клиентской и серверной частями делает возможной работу бухгалтеров в режиме удаленного доступа (например, из дома). Программа ТурбоБухгалтер разработана компанией ДИЦ. Руководство системного администратора на серверную часть разработано «Философтом».
ВВЕДЕНИЕ
Краткое содержание
Терминология и условные обозначения
Требования к конфигурации аппаратуры и программного обеспечения
Требования к квалификации администратора
1 Сетевая версия программы и принципы ее работы
1.1 Назначение сетевой версии программы
1.2 Базовые понятия и определения
1.2 План сервера
1.2.2 Базы данных и табличные журналы
1.2.3 Структура баз данных
1.2.4 Схемы доступа
1.2.5 Пользователи
1.3 Порядок работы с сетевой версией программы
1.4 Необходимое условие корректной работы сетевой версии программы
2 Установка сервера турбо бухгалтер 6.5
3 Пользовательский интерфейс сервера
3.1 Запуск программы Турбо Бухгалтер Сервер
3.2 Главное окно
3.3 Меню
3.4 Панель инструментов
3.5 Строка состояния
3.6 Список пользователей
4 Настройка плана сервера
4.1 Порядок выполнения настройки. Редактор плана сервера
4.2 Настройка баз данных, табличных журналов и их разделов
4.3 Структура баз данных: редактирование и реорганизация
4.4 Настройка схем доступа
4.5 Настройка перечня пользователей
4.6 Завершение работы с редактором плана сервера
5 Установка связи сервера с клиентскими рабочими местами
5.1Подключение клиентских мест к Серверу Турбо Бухгалтер 6.5
5.2. Отладка связи между клиентскими местами и программой-сервером.
5.3 Основные неполадки и способы их устранения
6 Управление работой клиентских модулей с сервера
6.1 Просмотр изменений, вносимых пользователями в данные
6.2 Отправка сообщений пользователям
6.3 Закрытие клиентских мест
6.4 Отключение клиентских мест
6.5 Потеря связи с клиентским местом
7 Взаимодействие пользователей с программой-сервером
7.1 Отключение от программы-сервера
7.2.Типичные неполадки при взаимодействии пользователя с программой-сервером
8 Оптимизация и настройка программы-сервера
8.1 Подготовительные и заключительные операции
8.2 Проверка наличия связи
8.3 Режим регистрации изменений записей общих данных
8.4 Пароль администратора сервера
8.5 Дополнительные параметры
9.Ведение резервных копий (зеркалирование) баз данных
9.1 Понятие и порядок зеркалирования
9.2 Настройка зеркалирования
9.3 Экспорт зеркалирования баз данных
9.4 Импорт зеркалирования баз данных
ПРИЛОЖЕНИЯ
Приложение A. Перенос баз данных и табличных журналов на сервер
Приложение B. Возможности работы в глобальных сетях
СПИСОК ИСПОЛЬЗУЕМОЙ ЛИТЕРАТУРЫ
УКАЗАТЕЛЬ
ГЛОССАРИЙ