Посібник користувача

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

Призначена для користувача документація ПС (user documentation) пояснює користувачам, як вони повинні діяти, щоб застосувати це ПС. Вона потрібна, якщо ПС припускає яку-небудь взаємодію з користувачами. До такої документації відносяться документи, якими керується користувач при инсталяции ПС (при установці ПС з відповідним налаштуванням на середовище застосування ПС), при застосуванні ПС для вирішення своїх завдань і при управлінні ПС (наприклад, коли це ПС взаємодіє з іншими системами). Ці документи частково порушують питання супроводу ПС, але не торкаються питань, пов'язаних з модифікацією програм.

У зв'язку з цим слід розрізняти дві категорії користувачів ПС: ординарних користувачів ПС і адміністраторів ПС. Ординарний користувач ПС (end - user) використовує ПС для вирішення своїх завдань (у своїй предметній області). Це може бути інженер, що проектує технічний пристрій, або касир, що продає залізничні квитки за допомогою ПС. Він може і не знати багатьох деталей роботи комп'ютера або принципів програмування. Адміністратор ПС (system administrator) управляє використанням ПС ординарними користувачами і здійснює супровід ПС, не пов'язаний з модифікацією програм. Наприклад, він може регулювати права доступу до ПС між ординарними користувачами, підтримувати зв'язок з постачальниками ПС або виконувати певні дії, щоб підтримувати ПС в робочому стані, якщо воно включене як частина в іншу систему.

Склад призначеної для користувача документації залежить від аудиторій користувачів, на які орієнтоване це ПС, і від режиму використання документів. Під аудиторією тут розуміється контингент користувачів ПС, у якого є необхідність в певній призначеній для користувача документації ПС [13.2]. Вдалий призначений для користувача документ істотно залежить від точного визначення аудиторії, для якої він призначений. Призначена для користувача документація повинна містити інформацію, необхідну для кожної аудиторії. Під режимом використання документу розуміється спосіб, що визначає, яким чином використовується цей документ. Зазвичай користувачеві досить великих програмних систем потрібно або документи для вивчення ПС (використання у вигляді інструкції), або для уточнення деякої інформації (використання у вигляді довідника).

Відповідно до робіт [13.1, 13.2] можна вважати типовим наступний склад призначеної для користувача документації досить великих ПС:

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

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

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

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

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

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

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