Програ́мна документа́ція — сукупність документів, що містять відомості, необхідні для розробки, виготовлення, супроводу та експлуатації програм. Програмна документація є одним з видів технічної документації.
Комплекс державних стандартів, що встановлюють взаємопов'язані правила розробки, оформлення та обігу програм і програмної документації називається «Єдина система програмної документації» (ЄСПД).
Основні поняття та визначення
Програма — дані, призначені для управління конкретними компонентами системи оброблення інформації з метою реалізації певного алгоритму.
Програмне забезпечення — сукупність програм системи обробки інформації і програмних документів, необхідних для експлуатації цих програм.
Програмний модуль — програма або функціонально завершений фрагмент програми, призначений для зберігання, трансляції, об'єднання з іншими програмними модулями та завантаження в оперативну пам'ять
Види програмних документів
Види програмних документів та їх зміст наведені в ГОСТ 19.101-77.
- Специфікація — містить інформацію щодо складу програми та документації на неї. Виконується на стадії робочого проєкту. Є обов'язковим документом для програмного забезпечення і тих програмних модулів, які можуть мати самостійне застосування.
- Відомість власників оригіналів (код виду документа — 05) — містить перелік підприємств, які зберігають оригінали програмних документів. Виконується на стадії робочого проєкту. Необхідність складання документа вирішується на етапі затвердження технічного завдання (за згодою).
- Текст програми (код виду документа — 12) — містить запис програми з необхідними коментарями. Виконується на стадії робочого проєкту. Необхідність — за погодженням.
- Опис програми (код виду документа — 13) — містить відомості про логічну структуру та функціонування програми. Виконується на стадії робочого проєкту. Необхідність — за погодженням.
- Програма та методика випробувань (код виду документа — 51) — містить вимоги, що підлягають перевірці при випробуваннях програми, а також порядок і методи їх контролю. Виконується на стадії робочого проєкту. Необхідність — за погодженням.
- Технічне завдання — містить призначення та область застосування програми, технічні, техніко-економічні та спеціальні вимоги, що ставляться до програми, необхідні стадії і терміни розробки, види випробувань. Виконується на стадії технічного завдання і є обов'язковим документом для комплексу. Необхідність складання технічних завдань на компоненти визначається за погодженням із замовником.
- Записка пояснення (код виду документа — 81) — містить схему алгоритму, загальний опис алгоритму і/або функціонування програми, а також обґрунтування прийнятих технічних та техніко-економічних рішень. Виконується на стадії ескізного та технічного проєктів. Необхідність — за погодженням.
- Експлуатаційні документи — містить відомості для забезпечення функціонування та експлуатації програми. Виконуються на стадії робочого проєкту. Необхідність — за погодженням для кожного документа окремо. Види експлуатаційних документів:
- формуляр (код виду документа — 30) — містить основні характеристики програми, комплектність і відомості про експлуатацію програми,
- опис застосування (код виду документа — 31) — містить відомості про призначення програми, області застосування, застосовуваних методах, класі вирішуваних задач, обмеження для застосування, мінімальної конфігурації технічних засобів,
- керівництво системного програміста (код виду документа — 32) — містить відомості для перевірки, забезпечення функціонування та налаштування програми на умови конкретного застосування,
- керівництво програміста (код виду документа — 32) — містить відомості, необхідні для експлуатації програми,
- керівництво оператора (код виду документа — 33) — містить відомості для забезпечення процедури спілкування оператора з обчислювальною системою в процесі виконання програми,
- опис мови (код виду документа — 35) — містить опис синтаксису і семантики мови програмування,
- керівництво з технічного обслуговування(код виду документа — 46) — містить відомості для застосування тестових і діагностичних програм при обслуговуванні технічних засобів.
Склад застосовуваних видів документів визначається розробником документів залежно від стадій розробки технологічної документації та типу виробництва.
Див. також
Примітки
- ГОСТ 19.101-77 Единая система программной документации. Виды программ и программных документов.
- ГОСТ 19.001-77 Единая система программной документации. Общие положения.
- ГОСТ 19781—90 Единая система программной документации. Обеспечение систем обработки информации программное.
Вікіпедія, Українська, Україна, книга, книги, бібліотека, стаття, читати, завантажити, безкоштовно, безкоштовно завантажити, mp3, відео, mp4, 3gp, jpg, jpeg, gif, png, малюнок, музика, пісня, фільм, книга, гра, ігри, мобільний, телефон, android, ios, apple, мобільний телефон, samsung, iphone, xiomi, xiaomi, redmi, honor, oppo, nokia, sonya, mi, ПК, web, Інтернет
Progra mna dokumenta ciya sukupnist dokumentiv sho mistyat vidomosti neobhidni dlya rozrobki vigotovlennya suprovodu ta ekspluataciyi program Programna dokumentaciya ye odnim z vidiv tehnichnoyi dokumentaciyi Kompleks derzhavnih standartiv sho vstanovlyuyut vzayemopov yazani pravila rozrobki oformlennya ta obigu program i programnoyi dokumentaciyi nazivayetsya Yedina sistema programnoyi dokumentaciyi YeSPD Osnovni ponyattya ta viznachennyaPrograma dani priznacheni dlya upravlinnya konkretnimi komponentami sistemi obroblennya informaciyi z metoyu realizaciyi pevnogo algoritmu Programne zabezpechennya sukupnist program sistemi obrobki informaciyi i programnih dokumentiv neobhidnih dlya ekspluataciyi cih program Programnij modul programa abo funkcionalno zavershenij fragment programi priznachenij dlya zberigannya translyaciyi ob yednannya z inshimi programnimi modulyami ta zavantazhennya v operativnu pam yatVidi programnih dokumentivVidi programnih dokumentiv ta yih zmist navedeni v GOST 19 101 77 Specifikaciya mistit informaciyu shodo skladu programi ta dokumentaciyi na neyi Vikonuyetsya na stadiyi robochogo proyektu Ye obov yazkovim dokumentom dlya programnogo zabezpechennya i tih programnih moduliv yaki mozhut mati samostijne zastosuvannya Vidomist vlasnikiv originaliv kod vidu dokumenta 05 mistit perelik pidpriyemstv yaki zberigayut originali programnih dokumentiv Vikonuyetsya na stadiyi robochogo proyektu Neobhidnist skladannya dokumenta virishuyetsya na etapi zatverdzhennya tehnichnogo zavdannya za zgodoyu Tekst programi kod vidu dokumenta 12 mistit zapis programi z neobhidnimi komentaryami Vikonuyetsya na stadiyi robochogo proyektu Neobhidnist za pogodzhennyam Opis programi kod vidu dokumenta 13 mistit vidomosti pro logichnu strukturu ta funkcionuvannya programi Vikonuyetsya na stadiyi robochogo proyektu Neobhidnist za pogodzhennyam Programa ta metodika viprobuvan kod vidu dokumenta 51 mistit vimogi sho pidlyagayut perevirci pri viprobuvannyah programi a takozh poryadok i metodi yih kontrolyu Vikonuyetsya na stadiyi robochogo proyektu Neobhidnist za pogodzhennyam Tehnichne zavdannya mistit priznachennya ta oblast zastosuvannya programi tehnichni tehniko ekonomichni ta specialni vimogi sho stavlyatsya do programi neobhidni stadiyi i termini rozrobki vidi viprobuvan Vikonuyetsya na stadiyi tehnichnogo zavdannya i ye obov yazkovim dokumentom dlya kompleksu Neobhidnist skladannya tehnichnih zavdan na komponenti viznachayetsya za pogodzhennyam iz zamovnikom Zapiska poyasnennya kod vidu dokumenta 81 mistit shemu algoritmu zagalnij opis algoritmu i abo funkcionuvannya programi a takozh obgruntuvannya prijnyatih tehnichnih ta tehniko ekonomichnih rishen Vikonuyetsya na stadiyi eskiznogo ta tehnichnogo proyektiv Neobhidnist za pogodzhennyam Ekspluatacijni dokumenti mistit vidomosti dlya zabezpechennya funkcionuvannya ta ekspluataciyi programi Vikonuyutsya na stadiyi robochogo proyektu Neobhidnist za pogodzhennyam dlya kozhnogo dokumenta okremo Vidi ekspluatacijnih dokumentiv formulyar kod vidu dokumenta 30 mistit osnovni harakteristiki programi komplektnist i vidomosti pro ekspluataciyu programi opis zastosuvannya kod vidu dokumenta 31 mistit vidomosti pro priznachennya programi oblasti zastosuvannya zastosovuvanih metodah klasi virishuvanih zadach obmezhennya dlya zastosuvannya minimalnoyi konfiguraciyi tehnichnih zasobiv kerivnictvo sistemnogo programista kod vidu dokumenta 32 mistit vidomosti dlya perevirki zabezpechennya funkcionuvannya ta nalashtuvannya programi na umovi konkretnogo zastosuvannya kerivnictvo programista kod vidu dokumenta 32 mistit vidomosti neobhidni dlya ekspluataciyi programi kerivnictvo operatora kod vidu dokumenta 33 mistit vidomosti dlya zabezpechennya proceduri spilkuvannya operatora z obchislyuvalnoyu sistemoyu v procesi vikonannya programi opis movi kod vidu dokumenta 35 mistit opis sintaksisu i semantiki movi programuvannya kerivnictvo z tehnichnogo obslugovuvannya kod vidu dokumenta 46 mistit vidomosti dlya zastosuvannya testovih i diagnostichnih program pri obslugovuvanni tehnichnih zasobiv Sklad zastosovuvanih vidiv dokumentiv viznachayetsya rozrobnikom dokumentiv zalezhno vid stadij rozrobki tehnologichnoyi dokumentaciyi ta tipu virobnictva Div takozhTehnichna dokumentaciya Programne zabezpechennyaPrimitkiGOST 19 101 77 Edinaya sistema programmnoj dokumentacii Vidy programm i programmnyh dokumentov GOST 19 001 77 Edinaya sistema programmnoj dokumentacii Obshie polozheniya GOST 19781 90 Edinaya sistema programmnoj dokumentacii Obespechenie sistem obrabotki informacii programmnoe