Руководство системного администратора – вспомогательный документ для прикладных программных продуктов и основной для серверных и системных, не имеющих непосредственных пользователей.

В случае небольших «монолитных» программ руководство системного администратора может оказаться документом небольшим по объему и простым по структуре. Руководство системного администратора на программный или аппаратно-программный комплекс, как правило, ощутимо сложнее, поскольку в нем приходится описывать каждый компонент по отдельности и способы их интеграции как друг с другом, так и со сторонним программным обеспечением: серверами баз данных, почтовыми серверами, антивирусами, средствами шифрования и пр.

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

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

Кроме того, в руководстве системного администратора могут быть описаны:

• пользовательский интерфейс административной консоли;
• утилиты командной строки и синтаксис их запуска;
• конфигурационные файлы и правила их написания;
• язык для составления управляющих скриптов.

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

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

Приблизительная структура руководства системного администратора следующая:

1. Общие сведения о программе (комплексе)

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

3. Системные требования

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

5. Административная консоль и работа с ней

6. Файл конфигурации. Составление и правка

7. Обязательная начальная настройка программы (комплекса)

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

9. Мероприятия по текущему обслуживанию программы (комплекса)

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

11. Аварийные ситуации и способы их устранения

Объем и особенности изложения информации в руководстве системного администратора зависят от используемых технических средств (ПК, серверных комплексов, планшетов, периферийных устройств и т. д.), применяемого программного обеспечения и решаемых с его помощью конкретных задач.