Зміст документа

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

У випадку невеликих «монолітних» програм керівництво системного адміністратора може виявитися документом невеликим по обсягу й простим за структурою. Керівництво системного адміністратора на програмний або апаратно-програмний комплекс, як правило, відчутно складніше, оскільки в ньому доводиться описувати кожний компонент окремо й способи їхньої інтеграції як один з одним, так і зі стороннім програмним забезпеченням: серверами баз даних, поштовими серверами, антивірусами, засобами шифрування та ін. (Далі для простоти ми будемо скрізь писати «програма», маючи на увазі як неподільну програму, так і комплекс, що включає в себе ряд взаємодіючих програмних компонентів.)

Отже, у керівництві системного адміністратора повинні бути викладені:

• призначення й область застосування програми (або комплексу);

• состав програми, основні принципи її функціонування;

• комплект поставки (якщо він не зазначений в окремому документі);

• системні вимоги для програми або її компонентів;

• краща черговість установки компонентів;

• процедура установки програми або кожного її компонента;

• порядок обов'язкового первісного настроювання програми;

• способи інтеграції встановлених копій компонентів між собою;

• інтеграція програми зі стороннім ПЗ, наприклад, із сервером БД;

• способи й періодичність контролю правильності роботи програми;

• порядок поточного обслуговування працюючих копій програми;

• порядок рішення всіляких допоміжних завдань;

• аварійні ситуації й способи їхнього усунення.

Чи є цей список тим вичерпним? Зовсім ні. Нерідко в керівництві системного адміністратора доводиться також описувати:

• користувальницький інтерфейс адміністративної консолі;

• утиліти командного рядка й синтаксис їхнього запуску;

• конфігураційні файли й правила їхнього написання;

• мова для складання керуючих скриптів.

Все залежить від того, які засоби для установки й настроювання програми реалізували її розроблювачі, які саме інструменти вони дають у руки системному адміністраторові.

Методика й стиль викладу

Методика викладу матеріалу в керівництві системного адміністратора сильно залежить від того, яким образом програмою можна управляти.

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

Якщо системному адміністраторові прийде активно становити конфігураційні файли й писати скрипти, документ буде ближче до керівництва програміста або опису мови програмування.

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

Структура керівництва системного програміста, наведена в ДСТ 19.503-79.

1. Загальні відомості про програму.

2. Структура програми.

3. Настроювання програми.

4. Перевірка програми.

5. Додаткові можливості.

6. Повідомлення системному програмістові.

Приблизна сучасна структура керівництва системного адміністратора.

1. Загальні відомості про програму (комплексі).

2. Архітектура й принципи функціонування.

3. Системні вимоги.

4. Установка програми (комплексу).

5. Адміністративна консоль і робота з нею.

6. Файл конфігурації. Складання й виправлення.

7. Обов'язкове початкове настроювання програми (комплексу).

8. Перевірка правильності функціонування програми (комплексу).

9. Заходу щодо поточного обслуговування програми (комплексу).

10. Оптимізація роботи програми (комплексу).

11. Аварійні ситуації й способи їхнього усунення.