Цілі й завдання. Методика й стиль викладу

Особливості

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

3. Керівництво з експлуатації (технічного обслуговування)

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

Експлуатація будь-якого устаткування розпадається на два види діяльності:

- цільове застосування;

- технічне обслуговування.

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

У загальному випадку застосовують устаткування одні люди, а обслуговують інші. Припустимо, в офісному коридорі встановили великий копіювальний апарат. Будь-який співробітник може скористатися ним для того, щоб зробити копію документа або навіть книги. Це цільове застосування. Разом з тим, системні адміністратори повинні час від часу перевіряти стан апарата, міняти або перезаправляти картридж, завантажувати папір, при необхідності викликати фахівця з ремонту – це технічне обслуговування.

Завдання керівництва з експлуатації – забезпечити необхідною технічною інформацією як користувача, що застосовує устаткування, так і обслуговує це устаткування фахівця.

У ряді випадків (наприклад, якщо через занадто великий обсяг документ стає незручний у використанні) доцільно розділити його на два томи: керівництво з експлуатації й керівництво з технічного обслуговування.

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

У керівництві з експлуатації устаткування повинні бути описані:

- устрій і принципи роботи устаткування;

- цільове застосування устаткування;

- технічне обслуговування устаткування;

- поточний ремонт устаткування;

- зберігання устаткування;

- порядок транспортування устаткування;

- припустимі способи утилізації устаткування.

Фактично, це розділи керівництва з експлуатації. Для різних видів устаткування кожний з них може виявитися більш-менш важливим.

Дата добавления: 2014-01-07