Зміст основних документів

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

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

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

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

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

• вимоги до програмного виробу - містить підрозділи:

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

умови експлуатації (умови навколишнього середовища, вибір типів носіїв інформації, вид обслуговування, кількість і кваліфікація персоналу);

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

• вимоги до програмної документації - дається склад програмної документації та вимоги до неї;

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

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

• порядок контролю та приймання - вказуються види випробувань і загальні вимоги до приймання роботи.

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

• вступ;

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

• технічні характеристики - містить підрозділи:

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

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

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

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

Програма та методика випробувань включає наступні розділи:

• об'єкт випробувань - дається найменування та позначення випробуваної програми;

• мета випробувань - вказується мета проведення випробувань;

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

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

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

• методи випробувань - наводиться опис використовуваних методів, а також результати проведення випробувань (перелік тестових прикладів, контрольні роздруківки тестових прикладів і т.п.).

Опис програми включає наступні розділи:

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

• функціональне призначення - даються класи розв'язуваних завдань та відомості про функціональні обмеження на їх застосування;

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

• вихідні дані - наводяться ті ж відомості, що і в розділі "Вхідні дані";

• опис логічної структури - містить підрозділи:

використовувані методи;

структуру програми з описом функцій складових частин і зв'язку між ними;

структуру і організацію даних, використовуваних у програмі;

алгоритм програми;

зв'язок програми з іншими програмами;

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

• використовувані технічні засоби - даються типи ЕОМ і пристроїв, які застосовуються при роботі програми.

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

Опис застосування - експлуатаційний документ, який включає розділи:

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

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

• опис завдання - визначається завдання та методи її вирішення;

• вхідні і вихідні дані - зазначаються відомості про вхідні і вихідні дані.

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

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

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

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

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

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

Керівництво оператора (користувача) - експлуатаційний документ, який включає розділи:

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

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

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

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