Руководство администратора

• Общие сведения
• Цели и задачи
• Содержание документа
• Методика и стиль изложения
• Типовая структура
• Особенности
• Примеры

Общие сведения

Документация:	системная или программная/эксплуатационная
Предмет:	система и/или программные средства для управления ее работой
Аудитория:	ответственный пользователь системы, обеспечивающий ее целевое применение (администратор)
Задачи:	обеспечить администратору системы возможность управлять ее функционированием
Стандарты:	-

Цели и задачи

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

Работа администратора многопользовательской системы, как правило, заключается в управлении учетными записями других пользователей, предоставлении им полномочий на доступ к данным и выполнение операций, а также в исправлении сделанных ими ошибок. Например, бывают автоматизированные системы, в которых вводить и редактировать данные может любой пользователь, а удалять - только администратор. Кроме того, администратор может заниматься ведением нормативно-справочной информации, загрузкой и выгрузкой данных, открытием и закрытием расчетных периодов (в биллинговых системах) и т. п. С этой точки зрения руководство администратора является системным документом и приобретает смысл только в условиях конкретной системы с живыми пользователями.

С другой стороны, системы часто создаются на основе тиражируемых программных продуктов или аппаратно-программных комплексов. В составе таких решений нередко поставляется программный компонент под названием 'Администратор', предназначенный для управления системой после ее развертывания. Руководство пользователя по этому компоненту тоже может быть озаглавлено словами 'Руководство администратора'. В этом случае оно представляет собой программный документ, уточненный при создании конкретной системы технологической инструкцией администратора.

Содержание документа

В руководстве администратора системы обязательно должны быть описаны:

• назначение и порядок применения системы;
• общие принципы и логика работы системы;
• обязанности администратора и связанные с ними операции;
• обязательность, регулярность и очередность выполнения всех операций;
• порядок выполнения каждой операции;
• проблемы в работе системы и способы их решения.

Руководство по административному модулю программного или программно-аппаратного комплекса содержит примерно те же сведения, но в более общем виде. Например, в нем должно быть объяснено, как создать учетную запись пользователя, но не может быть указано, когда это следует делать. Такая конкретика возникает только при внедрении продукта в некотором конкретном месте и отражается в технологических инструкциях или регламентах.

Методика и стиль изложения

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

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

Типовая структура

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

Структура руководства администратора системы.

1. Назначение системы.
2. Принципы функционирования системы.
3. Обязанности и задачи администратора.
4. Обслуживание системы.
   • Настройка параметров работы системы.
   • Ведение нормативно-справочной информации.
   • Учетные записи пользователей и управление ими.
   • Назначение пользователям прав доступа.
   • Загрузка и выгрузка данных.
5. Проблемы в работе системы и способы их решения.

Структура руководства по административному модулю программного или аппаратно-программного комплекса.

1. Общие сведения о комплексе.
2. Функционирование комплекса в рамках системы.
3. Интерфейс пользователя административного модуля.
4. Задачи по обслуживанию системы.
   • Настройка параметров работы системы.
   • Ведение нормативно-справочной информации.
   • Учетные записи пользователей и управление ими.
   • Назначение пользователям прав доступа.
   • Загрузка и выгрузка данных.
5. Типичные проблемы в работе системы и способы их решения.

В разделе 2 можно рассмотреть несколько наиболее типичных случаев применения комплекса и перечислить основные обязанности администратора системы в каждом из них.

Особенности

Руководство администратора не следует путать с руководством системного администратора. Первый документ говорит о том, как организовать и поддерживать целевое применение системы, второй - как обеспечить ее техническую работоспособность.

Примеры

АБС 'Омега'. Руководство администратора

Автоматизированная банковская система 'Омега' - собственная разработка одного из крупнейших банков России. Она представляет собой внутренний программный продукт, который внедряется и применяется территориальными подразделениями банка по всей стране. АБС включает в себя около десяти крупных функциональных подсистем. Подсистема 'Администрирование' - одна из них. Руководство администратора, структура которого приведена ниже, разработана компанией 'Философт' по заказу банка.

Обратите внимание на раздел 2. Это раздел, в котором объясняется, 'как мир устроен'.

1. Введение
 1.1. Назначение подсистемы
 1.2. Возможности подсистемы
 1.3. Требования к уровню подготовки пользователя
 1.4. Необходимая эксплуатационная документация
2. Принципы администрирования АБС 'Омега'
 2.1. Структура АБС 'Омега' и место ФП 'Администрирование' в ней
 2.2. Модель пользовательских полномочий
 2.3. Пользователь подсистемы администрирования и его полномочия
3. Условия применения
 3.1. Требования к обеспечению рабочего места администратора
4. Сеанс работы с подсистемой 
 4.1. Начало сеанса работы с подсистемой
 4.2. Завершение сеанса работы с подсистемой
5. Пользовательский интерфейс подсистемы
6. Описание операций
 6.1. Назначение полномочий пользователям
  6.1.1. Управление учетными записями пользователей
   6.1.1.1. Общие сведения
   6.1.1.2. Просмотр списков пользователей
   6.1.1.3. Просмотр информации о пользователе и редактирование реквизитов учетной записи
   6.1.1.4. Создание учетной записи пользователя
   6.1.1.5. Включение пользователя в группу пользователей
   6.1.1.6. Исключение пользователя из группы пользователей
  6.1.2. Управление группами пользователей
   6.1.2.1. Просмотр списков групп пользователей
   6.1.2.2. Просмотр информации о группе пользователей и редактирование реквизитов группы
   6.1.2.3. Создание и удаление группы пользователей
   6.1.2.4. Назначение ролей группе пользователей
  6.1.3. Управление ролями
   6.1.3.1. Просмотр списков ролей
   6.1.3.2. Просмотр информации о роли и редактирование реквизитов роли
   6.1.3.3. Создание и удаление роли
   6.1.3.4. Формирование списка полномочий роли
   6.1.3.5. Экспорт и импорт ролей
 6.2. Работа с источниками данных
 6.3. Просмотр списка всех загруженных объектов
 6.4. Просмотр списка всех загруженных операций
 6.5. Просмотр списка администрируемых функциональных подсистем
 6.6. Выполнение технологических операций
  6.6.1. Загрузка нормативно-справочной информации
   6.6.1.1. Обновление списка операций и объектов
   6.6.1.2. Обновление организационной структуры
 6.7. Получение отчетов
Глоссарий
Предметный указатель