Вимоги до структури та оформлення програмного проекту

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

Програмні проекти оформляються у відповідності до стандартів ЄСПД. Програмний проект будується як підмножина повного складу проекту. До нього належать такі документи:

- специфікація;

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

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

- керівництво оператора.

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

Титульна сторінка навчального програмного проекту наводиться в додатку Ж.

7.2 Особливості оформлення програмною проекту

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

7.3 Оформлення структурних елементів проекту

7.3.1 Оформлення специфікації

Специфікація є основним програмним документом до компонентів, що використовуються самостійно, і для комплексів. В загальному випадку специфікація повинна містити розділи:

– документація;

– комплекси;

– компоненти.

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

В розділ «Документація» заносять програмні документи на дану програму, крім специфікації і технічного завдання, у порядку зростання їх коду виду документа.

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

Рисунок 7.1

7.3.2 Оформлення тексту програми

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

Кожний із цих розділів реалізується записом програми на вхідній мові програмування, наприклад, Visual Basic, C#, Pascal, PHP, Perl, Java, C++, Assembler.

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

Інформаційна частина розділу складається з анотації та змісту. В анотації коротко описується призначення документа та його вміст.

Приклад оформлення тексту програми приведено в додатку И.

7.3.3 Оформлення опису програми

Інформаційну частина розділу складається з анотації та змісту. Вони повинні бути присутні обов’язково.

Опис програми повинен містити наступні розділи:

– загальні відомості;

– функціональне призначення;

– опис логічної структури;

– необхідні технічні засоби;

– виклик та завантаження;

– вхідні дані;

– вихідні дані.

У розділі «Загальні відомості» повинно бути вказано:

– позначення та назва програми;

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

– мови програмування, на яких написана програма,

У розділі «Функціональне призначення» вказують призначення програми і відомості про функціональні обмеження при використанні.

У розділі «Опис логічної структури» повинно бути вказано:

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

– методи, що використовуються;

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

– зв’язок програми з іншими програмами.

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

У розділі «Необхідні технічні засоби» вказують типи комп'ютерів та пристроїв, що використовуються при роботі програми.

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

У розділі «Вхідні дані» вказують:

– характер, організація і попередня підготовка вхідних даних;

– формат, описання та спосіб кодування вхідних даних.

У розділі «Вихідні дані» вказують:

– характер і організація вихідних даних;

– формат, описання та спосіб кодування вихідних даних.

Допускається вміст розділів ілюструвати прикладами, таблицями, схемами і графіками.

Приклад оформлення опису програми приведено в додатку І.

7.3.4 Оформлення керівництва оператора

Інформаційна частина розділу складається з анотації та змісту. Вони повинні бути присутні обов'язково.

Керівництво оператора повинно містити:

– призначення програми;

– умови використання програми;

– виконання програми;

– повідомлення оператору.

У розділі «Призначення програми» повинні міститись відомості призначення програми і інформація, достатня для розуміння функцій програми та її експлуатації.

У розділі «Умови виконання програми» повинні бути вказані умови, необхідні для функціонування програми (мінімальний склад апаратних та програмних засобів).

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

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

Допускається вміст розділів ілюструвати прикладами, таблицями, схемами і графіками.

Приклад оформлення керівництва оператора приведено в додатку Ї.