Lektsiya_4

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

2. Установка й первісне настроювання.

3. Основні поняття й визначення.

4. Інтерфейс користувача.

5. Робота із програмою.

6. Користувальницьке настроювання.

7. Повідомлення про помилки.

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

Особливості

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

1. Введення.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

7