Звіт повинен містити

1. Тема іметароботи.

2. Завдання.

3. Хід роботи.

4. Стислий лістинг програми.

5. Висновки.

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

1. Що таке файл допомоги?

2. Як створити такий файл?

3. Як створити зміст допомоги?

4. Як викликати файл допомоги?

Лабораторна робота № 6

Тема: Створення програмної документації.

Мета: навчитисястворювати програмну документацію для програмного продукту.

Теоретичні відомості

Користувальницька документація.

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

У зв'язку із цим варто розрізняти дві категорії користувачів ПС:

• ординарних користувачів ПС;

• адміністраторів ПС.

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

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

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

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

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

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

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

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

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

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