ЛАБОРАТОРНА РОБОТА № 8
ВИДИ ПРОГРАМ І ПРОГРАМНИХ ДОКУМЕНТІВ.
ВИМОГИ ДО ПРОГРАМНИХ ДОКУМЕНТІВ
Мета роботи: Ознайомитися із загальними положеннями по ЄСПД і вивчити види програм і програмних документів.
Єдина система програмної документації (ЄСПД) - комплекс держав-них стандартів, що встановлюють взаємозв’язані правила розробки, офор-млення та обертання програм і програмної документації.
У стандартах ЄСПД встановлюють вимоги, що регламентують розроб-ку, супровід, виготовлення і експлуатацію програм, що забезпечує можли-вість:
– уніфікації програмних виробів для взаємного обміну програмами та застосування раніше розроблених програм в нових розробках;
– зниження трудомісткості і підвищення ефективності розробки, су-проводу, виготовлення та експлуатації програмних виробів;
– автоматизації виготовлення і зберігання програмної документації.
Супровід програми включає аналіз функціонування, розвиток та удос-коналення програми, а також внесення змін в неї з метою усунення по-милок.
Правила і положення, встановлені в стандартах ЄСПД, розповсюд-жуються на програми та програмну документацію для обчислювальних машин, комплексів та систем незалежно від їх призначення та області за-стосування.
У склад ЕСПД входять:
– основоположні і організаційно-методичні стандарти;
– стандарти, що визначають форми і зміст програмних документів, які застосовуються при обробці даних;
– стандарти, що забезпечують автоматизацію розробки програмних до-кументів.
Розробка організаційно-методичної документації, що визначає і що регламентує діяльність організацій з розробки, супроводу і експлуатації програм, повинна проводитися на основі стандартів ЄСПД.
Стандарти ЄСПД поділяють на групи, приведені в таблиці 1.
Таблиця 1
КОД ГРУПИ |
НАЙМЕНУВАННЯ ГРУПИ |
0 |
Загальні положення |
1 |
Основоположні стандарти |
2 |
Правила виконання документації розробки |
3 |
Правила виконання документації виготовлення |
4 |
Правила виконання документації супроводу |
5 |
Правила виконання експлуатаційної документації |
6 |
Правила обертання програмної документації |
7 |
Резервні групи |
8 |
|
9 |
Інші стандарти |
Позначення стандартів ЄСПД будують за класифікаційною ознакою. До позначення стандарту ЄСПД повинні входити:
– цифри 19, призначені класу стандартів ЄСПД;
– одна цифра (після точки), що вказує код класифікаційної групи стан-дартів;
– двозначне число, що визначає порядковий номер стандарту в групі;
– двозначне число (після тире), що вказує рік реєстрації стандарту.
Приклад позначення стандарту:
ГОСТ 19.0 01-77
Рік реєстрації стандарту
Порядковий номер стандарту в групі
Класифікаційна група стандартів
Клас (стандарти ЄСПД)
Категорія стандарту (державний стандарт)
Програму (по ГОСТ 19781-83) допускається ідентифікувати та засто-совувати самостійно і (або) в складі інших програм.
Програми поділяють на види, приведені в таблиці 2.
Таблиця 2
ВИД ПРОГРАМИ |
ВИЗНАЧЕННЯ |
Компонент |
Програма, яка розглядується як єдине ціле, вико-нуюча закінчену функцію та застосовувана само-стійно чи в складі комплексу. |
Комплекс |
Програма, що складається з двох чи більше ком-понентів і (чи) комплексів, виконуючих взаємо-зв’язані функції, і застосовувана самостійно чи в складі другого комплексу. |
Документація, розроблена на програму, може використовуватися для реалізації і передачі програми на носіях даних, а також для виготовлення програмного виробу.
До програмних відносять документи, що містять відомості, необхідні для розробки, виготовлення, супроводу і експлуатації програм.
Види програмних документів і їх зміст приведені в таблиці 3.
Таблиця 3
Вид програмного документу |
Зміст програмного документу |
Специфікація |
Склад програми і документації на неї |
Відомість тримачів оригіналів |
Перелік підприємств, на яких зберігають оригінали програмних документів |
Текст програми |
Запис програми з необхідними коментарями |
Опис програми |
Відомості про логічну структуру та функціонування програми |
Програма та методика випробувань |
Вимоги, що належать перевірці при випробуванні програми, а також порядок і методи їх контролю |
Технічне завдання |
Призначення та область застосування програми, технічні, техніко-економічні і спеціальні вимоги, що пред'являються до програми, необхідні стадії та терміни розробки, види випробувань |
Пояснювальна записка |
Схема алгоритму, загальний опис алгоритму та (або) функціонування програми, а також обгрунтування прийнятих технічних і техніко-економічних рішень |
Експлуатаційні документи |
Відомість для забезпечення функціонування і експлуатації програми |
Види експлуатаційних документів і їх зміст приведені в таблиці 4.
Таблиця 4
Вид експлуатаційного документу |
Зміст експлуатаційного документу |
Відомість експлуатаційних документів |
Перелік експлуатаційних документів на програму |
Формуляр |
Основні характеристики програми, комплектність та відомості про експлуатацію програми |
Опис програми |
Відомість про призначення програми, область застосування, застосовуваних методах, клас вирішуваних задач, обмеження для застосування, мінімальну конфігурацію технічних засобів |
Посібник системного програміста |
Відомості для перевірки, забезпечення функціонування і настройки програми на умовах конкретного застосування |
Посібник програміста |
Відомості для експлуатації програми |
Посібник оператора
|
Відомості для забезпечення процедури спілкування оператора з обчислювальною системою в процесі виконання програми |
Опис мови |
Опис синтаксису і семантики програми |
Посібник по технічному обслуговуванню |
Відомості для застосування тестових і діагностичних програм при обслуговуванні технічних засобів |
У залежності від способу виконання і характеру застосування програм-ні документи поділяються на оригінал, дублікат і копію (ГОСТ 2.102-68), призначені для розробки, супроводу і експлуатації програми.
Види програмних документів і їх коди приведені в таблиці 5.
Таблиця 5
Код виду Документу |
Вид документу |
- 05 12 13 20 30 31 32 33 34 35 46 51 81 90-99
|
Специфікація Відомість тримачів оригіналів Текст програми Опис програми Відомість експлуатаційних документів Формуляр Опис застосування Посібник системного програміста Посібник програміста Посібник оператора Опис мови Посібник по технічному обслуговуванню Програма і методика випробувань Пояснювальна записка Інші документи |
Допускається об'єднувати окремі види експлуатаційних документів (за винятком відомості експлуатаційних документів та формуляра). Необ-хідність об'єднання цих документів вказується в технічному завданні. Об'єднаному документу призначають найменування та позначення одного з документів, що об'єднуються.
В об'єднаних документах повинні бути приведені відомості, які необхідно включати в кожний документ, що об'єднується.
На етапі розробки і затвердження технічного завдання визначають не-обхідність складання технічних умов, що містять вимоги до виготов-лення, контролю і приймання програми.
Технічні умови розробляють на стадії "Робочий проект".
Необхідність складання технічного завдання на компоненти, не при-значені для самостійного застосування, та комплекси, що входять в інші комплекси, визначається по узгодженню із замовником.
ВИМОГИ ДО ПРОГРАМНИХ ДОКУМЕНТІВ
Мета роботи: Вивчити загальні вимоги до програмних документів і вимоги до про-рамних документів виконаних друкованим способом.
Загальні вимоги
Програмний документ може бути представлений на різних типах носіїв даних. Програмний документ складається із таких умовних частин:
титульної;
інформаційної;
основної;
реєстрації змін.
Правила оформлення документу і його частин на кожному носії даних встановлюються стандартами ЄСПД на правила оформлення документу на відповідних носіях даних.
Титульна частина
Титульна частина складається з листа затвердження та титульного лис-та.
Правила оформлення листа затвердження та титульного листа – за ГОСТ 19.104-78.
Інформаційна частина
Інформаційна частина повинна складатися з анотації та змісту.
Необхідність включення інформаційної частини в різні види програм-них документів встановлена відповідними стандартами ЄСПД на ці доку-менти.
В анотації приводять відомості про призначення документу та корот-кий зміст його основної частини.
Зміст включає перелік записів про структурні елементи основної части-ни документу, в кожну з яких входять:
позначення структурного елемента (номер розділу, підрозділу і т.п.);
найменування структурного елемента;
адреса структурного елемента на носії даних (наприклад, номер сто-рінки, номер файла і т.п.).
Правила позначення структурних елементів основної частини докумен-ту та їх адресації встановлюються стандартами ЄСПД на правила оформ-лення документів на відповідних носіях даних.
Основна частина
Склад та структура основної частини програмного документу встанов-люється стандартами ЄСПД на відповідні документи.
Частина реєстрації змін
Про кожну зміну програмного документу в цій частині робиться запис відповідно до вимог ГОСТ19.603-78.
Вимоги до програмних документів,
виконаних друкованим способом
Даний стандарт встановлює правила виконання програмних документів для обчислювальних машин, комплексів та систем незалежно від їх при-значення та області використання і передбачених стандартами Єдиної си-стеми програмної документації (ЄСПД) для друкованого способу виконан-ня.
Стандарт не розповсюджується на програмний документ “Текст про-грами”.
Загальні вимоги
Склад та структура програмного документу встановлюється за ГОСТ 19.105-78.
Програмний документ виконують одним з таких способів:
машинописним – на одній стороні листа, через два інтервали; допускається через один або півтори інтервали, якщо забезпечується при-датність до мікрофільмування по ГОСТ 13.102-80 (pазд.1);
машинним – на одній стороні листа, з відстанню між основою рядків, що забезпечує придатність до мікрофільмування;
друкарським – відповідно до вимог, пред'явлених до видань, що виготовляються друкарським способом.
Примітки:
1. При виконанні програмного документу припускається комбінування друкованих способів, вказаних в п.1.2. цього документу.
2. Припускається виконання документу або його частини рукописним способом – на одній стороні листа чорними чорнилами або тушшю, основ-ним креслярським шрифтом за ГОСТ 2.304-81 з висотою літер не менш 2,5 мм.
Вписувати в програмні документи, виконані машинним способом, ок-ремі слова, формули, умовні знаки (від руки креслярським шрифтом), літе-ри латинського та грецького алфавітів, а також виконувати схеми та малю-нки необхідно чорними чорнилами або тушшю.
При машинописному, машинному та рукописному способах виконання документу помилки та графічні неточності, виявлені в процесі виконання, допускається виправляти стиранням не якісно виконаної частини тексту (креслення) і нанесенням на тому ж листі виправленого тексту (графіки) машинописом або чорною тушшю в залежності від способу виконання документу.
Пошкодження листів документу, помарки та сліди неповністю видале-ного колишнього тексту (графіки) не допускаються.
Програмні документи оформляють:
на листах формату А4 (ГОСТ 2.301-68) – при виготовленні документу машинописним або рукописним способом (форма 1). Допускається офор-млення на листах формату А3 (форма 2);
на листах форматів А4 і А3, що передбачаються вихідними характери-стиками пристроїв виводу даних – при виготовленні документу машинним способом. Допускаються відхилення розмірів листів, відповідних форма-там А4 і А3, що визначаються можливостями застосовуваних технічних засобів;
на листах друкарських форматів - при виготовленні документу дру-карським способом.
Матеріали програмного документу розташовуються в наступному по-рядку:
титульна частина;
лист затвердження (не входить в загальну кількість листів документу);
титульний лист (перший лист документу);
інформаційна частина;
анотація;
лист змісту;
основна частина:
текст документу (з малюнками, таблицями і т.п.);
додатки;
перелік термінів;
перелік скорочень;
перелік малюнків;
перелік таблиць;
предметний покажчик;
перелік посилальний документів;
перелік символів і числових коефіцієнтів;
частина реєстрації змін;
лист реєстрації змін.
Додатки, переліки термінів, скорочень, малюнків і таблиць, предмет-ний покажчик, переліки посилальний документів, символів і числових кое-фіцієнтів виконуються при необхідності. Переліки термінів і скорочень, предметний покажчик, перелік символів і числових коефіцієнтів треба складати в алфавітному порядку.
Інші переліки складають в порядку зростання номерів.
Вимоги до програмних документів, що містять в
основному тільки текст
Побудова документу.
При необхідності допускається ділити документ на частини. Розподіл на частини здійснюється на рівні не нижче розділу. Кожну частину ком-плектують окремо. Всім частинам призначають позначення документу у відповідності з ГОСТ 19.103-77.
Частини оформляють відповідно до вимог цього стандарту, при цьому в кінці змісту першої частини потрібно перелічувати позначення інших частин.
Допускається включати в документ частини тексту програми, що офор-мляються відповідно до правил мови, на якому написаний текст програми.
Нумерацію сторінок документу, а також нумерацію розділів, малюнків і таблиць виконують в межах кожної частини. Кожну частину починають з титульного листа.
Окрема нумерація сторінок документу в межах розділу та підрозділу не допускається.
Лист затвердження видають на весь документ з позначенням першої частини.
Інформаційна та основна частини програмного документу виконуються за формою 1 або 2, де:
поле 1 – порядковий номер сторінки;
поле 2 – позначення документу;
поле 3 - текст документу;
поле 4 – рядок змін; заповнюється у відповідності з вимогами ГОСТ 19.604 - 78.
Рамку (межі) формату сторінок документу допускається не наносити.
Анотацію розміщують на окремій (пронумерованій) сторінці сторінці із заголовком "АНОТАЦІЯ" і не нумерують як розділ.
В анотації вказують видання програми, стисло викладають призначен-ня і зміст документу. Якщо документ складається з декількох частин, в анотації вказують загальну кількість частин.
Зміст документу розміщують на окремій (пронумерованій) сторінці (сторінках) після анотації, забезпечують заголовком "ЗМІСТ", не нуме-рують як розділ та включають в загальну кількість сторінок документу.
У зміст документу включають номери розділів, підрозділів, пунктів та підпунктів, що мають заголовок, їх найменування і номери сторінок; номери і найменування (при наявності) додатків програмного документу та номери сторінок; інші найменування (перелік малюнків, таблиць і т.п.) та номери сторінок.
Найменування, включені до змісту, записують малими буквами. Вели-кими повинні друкуватися заголовні букви та абревіатури.
Текст кожного документу, при необхідності, розбивається на пункти, а пункти – на підпункти, незалежно від того, розділений документ на частини, розділи та підрозділи чи ні.
Структурними елементами тексту документу є розділи, підрозділи, пункти, підпункти та переліки.
Розділ – перший рівень розподілу, позначений номером і заголовком.
Підрозділ – частина розділу, позначена номером і має заголовок.
Пункт – частина розділу або підрозділу, позначена номером. Може ма-ти заголовок.
Підпункт – частина пункту, позначена номером, може мати заголовок.
Абзац – логічно виділена частина тексту, що не має номеру.
При відсутності розділів в тексті документу його першим структурним елементом є пункт.
Допускається вміщувати текст між заголовками розділу та підрозділу, між заголовками підрозділу та пункту.
Всередині підрозділів, пунктів та підпунктів можна дати переліки, які рекомендовано позначати арабськими цифрами з дужкою: 1), 2) і т.д. Допускається виділяти переліки проставленням дефіса перед текстом.
Не рекомендується робити посилання на елементи переліка.
Кожний структурний елемент починається з абзацного відступу.
Заголовки розділів пишуть великими буквами і розміщують симетрич-но відносно правої та лівої межі тексту.
Заголовки підрозділів записують з абзацу маленькими літерами (крім першої великої).
Допускається при машинному способі виконання документу заголовки підрозділів і пунктів записувати шрифтом, що є на друкуючому прист-рої.
Переноси слів в заголовках не допускаються. Крапку в кінці заголовка не ставлять.
Якщо заголовок складається з двох речень, їх розділяють крапкою.
Кожний розділ рекомендується починати з нового листа.
Відстані між заголовками та подальшим текстом, а також між заголов-ками розділу та підрозділу, повинні бути рівними:
при виконання документу машинописним способом – двом інтерва-лам;
при виконанні рукописним способом – не менше за 10 мм;
при виконанні машинним способом – не менш ніж три висоти шриф-ту.
Для розділів та підрозділів, текст яких записують на одній сторінці з текстом попереднього розділу, відстань між останнім рядком тексту та подальшим заголовком повинна бути рівною:
при виконанні документу машинописним способом – трьом машино-писним інтервалам;
при виконанні рукописним способом – не менше за 15 мм;
при виконанні машинним способом – не менш чотирьох висот шриф-ту.
Відстань між основами рядків заголовка приймають такою, як в тексті.
При друкарському способі видання документів вказані відстані офор-млюють за правилами для друкарських видань.
Розділи, підрозділи, пункти та підпункти слід нумерувати арабськими цифрами з крапкою.
Розділи повинні мати порядковий номер (1, 2 і т.д.). У межах розділу повинна бути крізна нумерація у всіх підрозділах, пунктах та підпунктах, що входять до даного розділу.
Нумерація підрозділів включає номер розділу та порядковий номер під-розділу, що входить в даний розділ, розділені крапкою (2.1, 3.1 і т.д.).
При наявності розділів і підрозділів до номеру підрозділу після крапки додають порядковий номер пункту та підпункту (3.1.1, 3.1.1.1 і т.д.).
Приклад структури тексту програмного документу та нумерація його розділів, підрозділів, пунктів та підпунктів приведено в додатку 2.