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

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

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

У відповідності до робіт можна вважати типовим наступний склад користувальницької документації для досить великих ПС:

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

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

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

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

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

Схожі статті