3.3.5. Опис мови

Вимоги до змісту та оформлення програмного документа по опису мови, що визначений ГОСТ 19.101-77 (програмування, управління завданням, організація обчислювального процесу) встановлює ГОСТ 19.506-79.

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

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

• елементи мови. Дають опис синтаксису і семантики базових і складових елементів мови.

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

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

• вбудовані елементи. Дають опис вбудованих в мову елементів (наприклад, функції, класи і т.д.) та правила їх використання.

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

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

3.3.6. Опис програми

Програмний документ “Опис програми” складається відповідно до ГОСТ 19.401-78.

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

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

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

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

• використовувані технічні засоби;

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

• вхідні дані;

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

Залежно від особливостей програми допускається вводити додаткові розділи або об'єднувати окремі розділи.

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

• позначення і найменування програми;

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

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

У розділі “Функціональне призначення” повинні бути вказані класи вирішуваних задач і (або) призначення програми і зведення про функціональні обмеженнях на застосування.

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

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

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

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

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

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

У розділі “Використовувані технічні засоби” повинні бути вказані типи електронних обчислювальних машин і пристроїв, які використовуються при роботі програми.

У розділі “Виклик і завантаження” повинні бути вказані:

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

• вхідні точки в програму.

Допускається указувати адреси завантаження, зведення про використовування оперативної пам'яті, об’єм програми.

У розділі “Вхідні дані” повинні бути вказані:

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

• опис і спосіб кодування вхідних даних.

У розділі “Вихідні дані” повинні бути вказані:

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

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

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