Записка пояснення

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

Зміст записки пояснення за стандартом (ГОСТ 19.404-79) повинен включати наступні розділи:

· вступ;

· призначення і сфера застосування;

· технічні характеристики;

· очікувані техніко-економічні показники;

· джерела, використовувані при розробці.

У розділі Введення вказують найменування програми і документу, на підставі якого ведеться розробка.

У розділі Призначення і сфера застосування вказують призначення програми і дають коротку характеристику сфери застосування.

Розділ Технічні характеристики повинен містити наступні підрозділи:

· постановку завдання, опис вживаних математичних методів і допущень і обмежень, пов'язаних з вибраним математичним апаратом;

· опис алгоритмів і функціонування програми з обгрунтуванням прийнятих рішень;

· опис і обгрунтування вибору способу організації вхідних і вихідних даних;

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

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

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

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

11.8.Керівництво системного програміста. Вимоги до змісту і оформлення.

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

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

Складання документації для користувачів має свої особливості, пов'язані з тим, що користувач, як правило, не є професіоналом в області розробки програмного забезпечення. У книзі С. Дж. Гримм дані рекомендації по написанню подібної програмної документації :

· враховуйте інтереси користувачів - керівництво повинне містити усі інструкції, необхідні користувачеві;

· викладайте ясно, використовуйте короткі пропозиції;

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

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

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

· загальні відомості про програмний продукт;

· опис установки;

· опис запуску;

· інструкції по роботі (чи опис призначеного для користувача інтерфейсу);

· повідомлення користувача.

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

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

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

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

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