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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Особливості

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

 

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

 

Цілі й завдання

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

ДСТ 2.610-2006 містить наступну типову структуру керівництва з експлуатації.

1. Введення.

2. Опис і робота.

o Опис і робота виробу.

§ Призначення виробу.

§ Характеристики (властивості).

§ Состав виробу.

§ Пристрій і робота.

§ Засоби виміру, інструмент і приналежності.

§ Маркування й пломбування.

§ Упакування.

o Опис і робота складових частин виробу.

3. Використання по призначенню.

o Експлуатаційні обмеження.

o Підготовка виробу до використання.

§ Міри безпеки при підготовці виробу.

§ Правила й порядок заправлення виробу ПММ.

§ Обсяг і послідовність зовнішнього огляду виробу.

§ Правила й порядок огляду робочих місць.

§ Правила й порядок огляду й перевірки готовності виробу до використання.

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

§ Вказівки про орієнтування виробу.

§ Особливості підготовки виробу до використання з різних ступенів готовності.

§ Вказівки про взаємозв'язок (з'єднанні) даного виробу з іншими виробами.

§ Вказівки по включенню й випробуванню роботи виробу.

§ Перелік можливих несправностей виробу в процесі його підготовки й рекомендації з дій при їхньому виникненні.

o Використання виробу.

§ Порядок дії обслуговуючого персоналу при виконанні завдань застосування виробу.

§ Порядок контролю працездатності виробу.

§ Перелік можливих несправностей у процесі використання виробу по призначенню й рекомендації з дій при їхньому виникненні.

§ Перелік режимів роботи виробу, а також характеристики основних режимів роботи.

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

§ Порядок приведення виробу у вихідне положення.

§ Порядок вимикання виробу, зміст і послідовність огляду виробу після закінчення роботи.

§ Порядок заміни, поповнення й контролю якості ПММ.

§ Міри безпеки при використанні виробу по призначенню.

o Дії в екстремальних умовах.

o Особливості використання доробленого виробу.

4. Технічне обслуговування.

o Технічне обслуговування виробу.

§ Загальні вказівки.

§ Міри безпеки.

§ Порядок технічного обслуговування виробу.

§ Перевірка працездатності виробу.

§ Технічний огляд.

§ Консервація (розконсервування, переконсервування).

o Технічне обслуговування складових частин виробу.

5. Поточний ремонт.

6. Зберігання.

7. Транспортування.

8. Утилізація.

 

Контрольні питання

 

1. Надайте докладну інформацію про цілі й завдання керівництва програміста.

2. Надайте докладну інформацію про зміст документа керівництва програміста.

3. Надайте докладну інформацію про методику й стиль викладення керівництва програміста.

4. Надайте докладну інформацію про типову структуру керівництва програміста.

5. Надайте докладну інформацію про цілі й завдання керівництва системного адміністратора (системного програміста).

6. Надайте докладну інформацію про зміст документа керівництва системного адміністратора (системного програміста).

7. Надайте докладну інформацію про методику й стиль викладення керівництва системного адміністратора (системного програміста).

8. Надайте докладну інформацію про типову структуру керівництва системного програміста.

9. Надайте докладну інформацію про типову структуру керівництва системного адміністратора.

10. Надайте докладну інформацію про цілі й завдання керівництва з експлуатації (технічного обслуговування).

11. Надайте докладну інформацію про зміст документа керівництва з експлуатації (технічного обслуговування).

12. Надайте докладну інформацію про типову структуру керівництва з експлуатації (технічного обслуговування).