4.7. Документування програмного забезпечення сапр

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

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

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

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

ЄСПД встановлює такі види програмних документів:

• специфікацію, яка містить склад програми та документацію на неї;

• відомість власників оригіналів - перелік підприємств, на яких зберігають оригінали програмних документів;

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

• пояснювальну записку, яка містить загальний опис алгоритму та функціонування програми;

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

• опис програми - відомості про логічну структуру та функціонування програми;

• текст програми - запис програми з необхідними коментарями;

• експлуатаційні документи, які, у свою чергу, містять:

відомість експлуатаційних документів - перелік експлуатаційних документів на програму;

формуляр - визначає основні характеристики програми, комплектність і відомості про експлуатацію;

опис застосування - містить відомості про призначення, сферу застосування програми, методи та клас вирішуваних завдань;

керівництво програміста - містить відомості, необхідні при експлуатації програм;

керівництво системного програміста - містить відомості для перевірки, забезпечення функціонування та налаштування програми на умови конкретного застосування;

опис мови - визначає синтаксис і семантику мови взаємодії користувача з програмою;

керівництво оператора - містить відомості, необхідні для забезпечення процедури спілкування оператора ЕОМ у процесі виконання програми;

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

Склад програмного документа

Матеріали кожного програмного документа необхідно розташовувати в такій послідовності:

• лист затвердження;

• титульний лист;

• анотація, в якій коротко викладають призначення і зміст документа;

• зміст, текст документа (з малюнками, таблицями тощо);

• додатки;

• перелік документів посилань.