Керівництво оператора

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

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

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

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

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

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

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

1. Мінімум теоретичних введень і концептуальних розділів. Якщо теорія все-таки необхідна, вона вся повинна бути зібрана в один розділ.

2. Мінімум явних і неявних посилань усередині документа. Описи повторюваних при виконанні різних операцій процедур по можливості краще дублювати.

3. Мінімум розгалужень при описі процедур. Ніяких умов виду «якщо ви хочете». В оператора немає бажань, а є обов'язки.

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

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

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

1. Призначення програми.

2. Умови виконання програми.

3. Виконання програми.

4. Повідомлення операторові.

У сучасних умовах у цю структуру доцільно додати розділ «Інтерфейс користувача», актуальний сьогодні для більшості програм. У випадку програм, що припускають діалоговий режим роботи, можна перейменувати розділ «Виконання програми» в «Виконання операцій» або описати кожну операцію або групу операцій у самостійному розділі першого рівня.

Особливості

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

Керівництво користувача

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

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

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

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

Керівництво користувача містить повний опис програми з погляду цільового застосування останньої. У керівництві користувача обов'язково повинні бути описані:

- призначення програми;

- основні завдання й можливості;

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

- користувальницький інтерфейс програми;

- порядок рішення основних користувальницьких завдань;

- всі функції програми й порядок їхнього застосування;

- користувальницьке настроювання програми;

- проблеми при використанні й способи їхнього рішення.

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

Ніколи або майже ніколи керівництво користувача не розглядається як навчальне керівництво по предметній області.