Добавил:
Upload Опубликованный материал нарушает ваши авторские права? Сообщите нам.
Вуз: Предмет: Файл:
Методичка ДП 7080403.doc
Скачиваний:
12
Добавлен:
07.02.2016
Размер:
5.22 Mб
Скачать

2.5 Склад і зміст програмної документації

Робоча ПД розробленого ПП має містити наступні обов’язкові програмні та експлуатаційні документи:

  • специфікацію ПД;

  • текст програми;

  • опис програми;

  • опис застосування;

  • порадник користувача.

При необхідності згідно ЗДП або ТЗ за погодженням з керівником ДП до складу робочої ПД можуть бути включені також:

  • фоpмуляp;

  • програма та методика іспитів;

  • порадник програміста;

  • порадник системного програміста;

  • порадник системного адміністратора;

  • опис мови.

Всі перелічені документи повинні бути виконані та оформлені у відповідності з вимогами ЄСПД (ГОСТ 19.001-77).

Друковані листи затвердження всіх ПД виконуються згідно ГОСТ 19.104-78, та розміщуються в Додатку А ПЗ.

Всі листи затвердження ПД повинні мати необхідні підписи та затвердження. Приклад оформлення листів затвердження приведено у Додатку С.

Повні тексти всіх ПД (з титульними листами, але без листів специфікацій) розміщуються на компакт-диску з додатками відповідно до таблиці 2.2.

Максимальний обсяг опису програми не повинен перевищувати 10 сторінок, опису застосування – 5 сторінок, порадника користувача – 15 сторінок (без титульних аркушів та інформаційної частини).

2.5.1 Зміст специфікації програмних документів

Основним ПД є специфікація. Вимоги до структури та змісту специфікації встановлені ГОСТ 19.202-78.

Специфікація не має інформаційної частини (розділів «Анотація» та «Зміст»). Натомість специфікація складається з листа затвердження, титульного листа і таблиці з описом документів, яка складається в загальному випадку з трьох розділів:

  • документація, де описуються документи: текст програми, опис програми, опис застосування, порадник користувача, пояснювальна записка тощо, загалом всі документи на розроблений ПП, крім самої специфікації;

  • комплекс, де описується власне ПП (комплекс – це програма, що складається з двох або більше компонентів, які виконують взаємопов’язані функції);

  • компоненти, де описуються тексти та описи програм (компонент – це програма, яка розглядається як єдине ціле для виконання певної завершеної функції і застосовується в складі комплексу).

Таблиця з описом документів має вигляд, представлений в табл. 2.3.

2.5.2 Зміст документу «Текст програми»

Документ «Текст програми» складається з листа затвердження, титульного листа і власне тексту програми. Текст програми записується з урахуванням правил написання програм відповідною мовою і повинен бути докладно коментованим.

Вимоги до структури та змісту тексту програми встановлені ГОСТ 19.401-78. Текст програми не має інформаційної частини (розділів «Анотація» та «Зміст»).

Таблиця 2.3 - Оформлення специфікації ПД

Позначення

Найменування

Примітки

Документація

Комплекс

Компоненти

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

В той же час в Додаток В «Тексти програми» ПЗ включають роздрук лише основних модулів програми.