| Документация: | программная/эксплуатационная |
| Предмет: | программа, комплекс, программный компонент комплекса или системы |
| Аудитория: | системные администраторы, осуществляющие установку программы и поддерживающие системы в рабочем состоянии |
| Задачи: | обеспечить системному администратору возможность самостоятельно установить программу и поддерживать ее функционирование в системе |
| Стандарты: | ГОСТ 19.503-79 |
| Синонимы: | руководство системного программиста |
Если программа более-менее проста, пользователь может установить ее себе на компьютер самостоятельно. Поддерживать ее работоспрособность, например, выполнить переустановку, если возникнут какие-нибудь проблемы, он тоже, как правило, в состоянии.
Сложными, в том числе, серверными и сетевыми программными продуктами приходится заниматься квалифицированным специалистам, системным администраторам. Более того, во многих компаниях сотрудникам запрещено устанавливать на своих рабочих местах программы по своему усмотрению. Даже простые программы там ставит только системный администратор.
В обязанности системного администратора также входит поддержание работоспособности программ, используемых в рамках тех или иных систем. Эта деятельность может заключаться в периодической проверке логов, резервном копировании данных, замерах производительности, устранении различных технических проблем.
Руководство системного администратора — программный документ, предоставляющий специалисту информацию, необходимую для выполнения этой работы.
В ЕСПД специалист, сходный по обязанностям с современным системным администратором, называется системным программистом, а адресованный ему документ — руководством системного программиста.
Руководство системного администратора — вспомогательный документ для прикладных программных продуктов и основной для серверных и системных, не имеющих непосредственных пользователей.
В случае небольших «монолитных» программ руководство системного администратора может оказаться документом небольшим по объему и простым по структуре. Руководство системного администратора на программный или аппаратно-программный комплекс, как правило, ощутимо сложнее, поскольку в нем приходится описывать каждый компонент по отдельности и способы их интеграции как друг с другом, так и со сторонним программным обеспечением: серверами баз данных, почтовыми серверами, антивирусами, средствами шифрования и пр. (Далее для простоты мы будем везде писать «программа», имея в виду как неделимую программу, так и комплекс, включающий в себя ряд взаимодействующих программных компонентов.)
Итак, в руководстве системного администратора должны быть изложены:
Является ли этот список тем исчерпывающим? Вовсе нет. Нередко в руководстве системного администратора вдобавок приходится описывать:
Все зависит от того, какие средства для установки и настройки программы реализовали ее разработчики, какие именно инструменты они дают в руки системному администратору.
Методика изложения материала в руководстве системного администратора сильно зависит от того, каким образом программой можно управлять.
Если большинство задач решается через административную консоль с графическим интерфейсом, то документ будет больше похож на руководство пользователя или руководство администратора.
Если системному администратору придется активно составлять конфигурационные файлы и писать скрипты, документ будет ближе к руководству программиста или описанию языка программирования.
Структура руководства системного программиста, приведенная в ГОСТ 19.503-79.
Приблизительная современная структура руководства системного администратора.
Если речь идет о сложных программных или аппаратно-программных комплексах, то системный администратор — это квалифицированный специалист, которому приходится принимать нетривиальные решения. Чтобы удовлетворить его потребности в информации, составителю документации необходимо понимать, как мыслит его читатель, что и в какой момент может его заинтересовать, какая подробность изложения материала будет достаточной для него. Поэтому разрабатывать руководство системного администратора должен либо его коллега, имеющий к тому же навыки технического писателя, либо технический писатель, имеющий хотя бы небольшой опыт работы системным администратором.
ТурбоБухгалтер — одна из наиболее популярных в нашей стране программ автоматизации бухгалтерского учета. Сетевая версия программы позволяет организовать совместную работу нескольких бухгалтеров с общим набором данных. Клиент-серверная архитектура и применение протокола TCP/IP для обмена данными между клиентской и серверной частями делает возможной работу бухгалтеров в режиме удаленного доступа (например, из дома). Программа ТурбоБухгалтер разработана компанией ДИЦ. Руководство системного администратора на серверную часть разработано «Философтом».
ВВЕДЕНИЕ
i. Краткое содержание
ii. Терминология и условные обозначения
iii. Техническая поддержка
iv. Требования к конфигурации аппаратуры и программного обеспечения
v. Требования к квалификации администратора
1. СЕТЕВАЯ ВЕРСИЯ ПРОГРАММЫ И ПРИНЦИПЫ ЕЕ РАБОТЫ
1.1. Назначение сетевой версии программы
1.2. Базовые понятия и определения
1.2.1. План сервера
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. Отладка связи между клиентскими местами и программой-сервером.
Основные неполадки и способы их устранения
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. Возможности работы в глобальных сетях
СПИСОК ИСПОЛЬЗУЕМОЙ ЛИТЕРАТУРЫ
УКАЗАТЕЛЬ
ГЛОССАРИЙ