6. Пояснювальна записка

Пояснювальна записка має вмiщати такi роздiли:

- вступ;

- призначення i галузь застосування;

- технiчнi характеристики;

- очiкуванi технiко-економiчнi показники;

- джерела, використанi при розробцi.

В залежностi вiд особливостей документу окремi роздiли (пiдроздiли) допускається об’єднувать, а також вводити новi роздiли (пiдроздiли ).

Змiст роздiлiв.

6.1. В роздiлi “Вступ” указують назву програми та (або) умовне позначення теми розробки, а також документи, на основi яких ведеться розробка з висвiтленням органiзацiї i дати затвердження.

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

6.3. Роздiл “Технiчнi характеристики” має вмiщати слiдуючi пiдроздiли:

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

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

- опис i обгрунтування вибору складу технiчних i програмних засобiв на основi проведенних розрахункiв i (або) аналiзiв, роподiлу носiїв даних, що використовує програма.

6.4. В роздiлi “Очiкуванi технiко-економiчнi показники” указують:

- технiко-економiчнi показники, якi обгрунтовують перевагу вибранного варiанту технiчного рiшення, а також, при необхiдностi, очiкуванi оперативнi показники.

6.5. В роздiлi “Джерела, використанi при розробцi” указують прелiк науково-технiчних публiкацiй, нормативно-технiчних документiв та iнших науково-технiчних матерiалiв, на якi є посилання в основному документi.

6.6. В додатку до документу можуть бути включенi таблицi, обгрунтування, методики, розрахунки i iншi документи, використани при розробцi.

6.2. Памятка програмiста (системного програміста) має містити наступні роздiли:

• загальнi вiдомостi про програму;

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

• вiдлагодження програми;

• перевiрка програми;

• додатковi можливостi;

• повiдомлення системному програмiсту.

В залежностi вiд особливостей документу дозволяється об’єднувати окремi роздiли або вводити новi.

В обгрунтованих випадках допускається роздiл “Додатковi можливостi” не приводити, а в назвах роздiлiв випускати слово “програма” або замiняти його на “назва програми” .

6.3. В роздiлi “Загальнi вiдомостi про програму” мають бути указанi призначення i функцiї програми i вiдомостi про технiчнi i програмнi засоби, якi забезпечують виконання даної програми.

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

6.5. В роздiлi “Вiдлагодження програми” має бути приведено опис дiй по вiдлагодженню програми за умови конкретного застосування (настройка на склад технiчних засобiв, вибiр функцiй та iнше).

При необхiдностi приводять пояснюючi приклади.

6.6. В роздiлi “Перевiрка програми” має бути приведено опис способiв перевiрки, якi дозволяють дати загальнi заключення про працездатнiсть програми (контрольнi приклади, методи запуска, результати).

6.7. В роздiлi “Додатковi можливостi” має бути приведено опис додаткових роздiлiв функцiональних можливостей програми i спосiб їх вiдбору.

6.8. В роздiлi “Повiдомлення системному програмiсту” мають бути указанi тексти повiдомлень, що видаються пiд час настроювання, перевiрки програми, а також пiд час виконання програми, опис їх змiсту i дiй, якi необхiдно прийняти по цим повiдомленням.

6.9. В додатку до пам’ятки системного програмiста можуть бути приведенi додатковi матерiали (приклади, iлюстрацiї, таблицi, графiки i т.п.)

6.10. В роздiлi “Призначення i умови застосування програми” мають бути указанi призначення i функцiї, виконуванi програмою, умови необхiднi для виконання програми (об’єм оперативної пам’ятi, вимоги до складу i параметрiв периферiйних пристроїв, вимоги до програмного забезпечення i т.п.).

6.11. В роздiлi “Характеристикi програми” має бути приведено опис основних характеристик i особливостей програми (тимчасовi характеристики, режим роботи, засоби контролю правильностi виконання i самовiдновлення програми i т.п.).

6.12. В роздiлi “Звертання до програми” має бути приведено опис процедур виклику програми (способи передачi управлiння програмi та її параметрiв та таке iнше).

6.13. В роздiлi “Вхiднi i вихiднi данi” має бути приведений опис органiзацiї використання вхiдної i вихiдної iнформацiї i, при необхiдностi, її кодування.

6.14. В роздiлi “Повiдомлення” мають бути указанi тексти повiдомлень, якi видаються програмiсту або оператору пiд час виконання програми, опис їх змiсту i дiї, якi необхiдно здiйснювати за цими повiдомленнями.

6.15. В додатку до пам’ятки програмiсту можуть бути приведенi додатковi матерiали (приклади, iлюстрацiї, таблицi, графiки i т.п.).

6.16. Пам’ятка оператору має мiстити слiдуючи роздiли;

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

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

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

• повiдомлення оператору.

В залежностi вiд особливостей документу допускається об’єднати окремi роздiли або вводити новi.