11.6.Стадії розробки. Загальні вимоги до програмних документів. Технічне завдання.

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

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

Види програмних документів

До програмних відносять документи, що містять відомості, необхідні для розробки, супроводу і експлуатації програмного забезпечення. Документування програмного забезпечення здійснюється відповідно до Єдиної системи програмної документації (ГОСТ 19.ХХХ). Так, ГОСТ 19.101-77 встановлює види програмних документів для програмного забезпечення різних типів. Нижче перераховані основні програмні документи за цим стандартом і вказано, яку інформацію вони повинні містити.

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

Відомість утримувачів оригіналів (код виду документу - 05) повинна містити список підприємств, на яких зберігаються

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

Текст програми (код виду документу - 12) повинен містити текст програми з необхідними коментарями. Необхідність цього документу визначається на етапі розробки і затвердження технічного завдання.

11.7.Опис програми. Записка пояснення.

Опис програми (код виду документу - 13) повинен містити відомості про логічну структуру і функціонування програми.

Відомість експлуатаційних документів (код виду документу - 20) повинна містити перелік експлуатаційних документів на програму, до яких відносяться документи з кодами 30, 31, 32, 33, 34, 35, 46. Необхідність цього документу також визначається на етапі розробки і затвердження технічного завдання.

Формуляр (код виду документу - 30) повинен містити основні характеристики програмного забезпечення, комплектність і відомості про експлуатацію програми.

Опис застосування (код виду документу - 31) повинен містити зведення про призначення програмного забезпечення, сферу застосування, вживані методи, клас вирішуваних завдань, обмеження для застосування, мінімальної конфігурації технічних засобів.

Керівництво системного програміста (код виду документу - 32) повинне містити відомості для перевірки, забезпечення функціонування і налаштування програми на умови конкретного застосування.

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

Керівництво оператора (код виду документу - 34) повинне містити зведення для забезпечення процедури спілкування оператора з обчислювальною системою в процесі виконання програмного забезпечення.

Опис мови (код виду документу - 35) повинен містити опис синтаксису і семантики мови.

Керівництво по технічному обслуговуванню (код виду документу - 46) повинне містити відомості для застосування тісто

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

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

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

Складається на стадії ескізного і технічного проектів.

Інші документи (коди виду документу - 90-99) можуть складатися на будь-яких стадіях розробки, т. е. на стадіях ескізного, технічного і робочого проектів.

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

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

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

• вступ;

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

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

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

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

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

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

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

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

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

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

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

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

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

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