Гост -79 керівництво програміста

Цей стандарт встановлює вимоги до змісту та оформлення програмного документа «Керівництво програміста», певного ГОСТ 19.101-77.

Стандарт повністю відповідає СТ РЕВ 2095-80.

1. ЗАГАЛЬНІ ПОЛОЖЕННЯ

1.1. Структуру і оформлення документа встановлюють відповідно до ГОСТ 19.105-78.

Складання інформаційної частини (анотації та змісту) є обов'язковим.

1.2. Керівництво програміста повинно містити наступні розділи:

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

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

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

2.2. У розділі «Характеристика програми» має бути наведений опис основних характеристик і особливостей програми (тимчасові характеристики, режим роботи, засоби контролю правильності виконання та самовосстанавліваемості програми і т.п.).

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

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

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

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