Види програмних документів

Главная | Обратная связь | Поможем написать вашу работу!

1. Код країни, код організації-розробника

2. Реєстраційний номер програмного виробу

3. Номер редакції (версія програми)

ДЕРЖСТАНДАРТ ГОСТ 19.101-77 [1] визначає види програмних документів. Програмними документами є такі документи, що містять відомості, необхідні для розробки, супроводу й експлуатації програм. Для можливості посилання на програмні документи у ГОСТах їм присвоєні відповідні коди, що для експлуатаційних документів наведені в таблиці 4.

Таблиця 4 – Види експлуатаційних програмних документів

Код виду документа	Вид документа	Вміст документа
немає коду	Специфікація	Склад програми та перелік документації на неї
	Текст програми	Програмний код з коментарями
	Опис програми	Відомості про логічну структуру та функціонування програми
	Керівництво оператора	Необхідні відомості для забезпечення роботи оператора при виконанні програми
	Програма й методика випробувань	Вимоги, що підлягають перевірці при випробуваннях програми, а також порядок і методи їхнього контролю
	Пояснювальна записка	Схеми та опис алгоритмів, опис функціонування програми, обґрун-тування прийнятих рішень

Шифри документів

Для ідентифікації документа ЄСПД ГОСТ 19.103-77 [2] визначає структуру його шифру. На рисунку 1 подано структуру шифру для специфікації, а на рисунку 2 – для інших програмних документів.

Рисунок 1 – Структура шифру специфікації

	ХХ. ХХ.	ХХХХХ	-ХХ	ХХ	ХХ	- ХХ
1. Код країни, код організації-розробника
2. Реєстраційний номер програмного виробу
3. Номер редакції (версія програми)
4. Код виду документа
5. Номер документа даного виду
6. Номер частини документа

Рисунок 2 – Структура шифру інших програмних

документів (крім специфікації)

Для студентських робіт, присвячених розробці програм та програмних документів, на кафедрі ОТП вирішено, що у загальній частині шифру замість коду країни та організації (перша кодова група) необхідно вказувати назву факультету та індекс навчальної групи студента, а замість реєстраційного номера програмного виробу (друга кодова група) – п'ятизначний номер залікової книжки.

Таким чином, наприклад, шифр документа «Пояснювальна записка», що розроблена студентом групи КІТ39А із заліковою книжкою за номером 20176, буде такий: КІТ.39А.20176-01 81 01-1

Відповідно до вимог ГОСТ 19.106-96 [3] шифр документа проставляється на кожному аркуші текстової частини документа у верхньому його колонтитулі посередині.

Опис програмних документів

Загальні вимоги

Згідно вимог ГОСТ 19.105-78 [4] програмні документи складаються:

– з титульної частини;

– інформаційної частини;

– основної частини.

Титульна частина програмного документа містить:

– аркуш затвердження (див. додаток А). Це завжди перший аркуш документа. Він не нумерується;

– титульний аркуш (див. додаток Б), це друга сторінка документа; її номер – 1, але номер на цій сторінці не ставиться.

Інформаційна частина документа містить:

– анотацію – це стисла інформація (до 5 рядків) про зміст доку-мента; пишеться українською, російською та англійською мовами на одній сторінці; розташовується за титульним аркушем; номер аркуша анотації два, але цей номер на аркуші не ставиться;

– зміст (зміст містить усі документи, крім специфікації).

Основна частина документа містить:

– перелік умовних позначень, символів, одиниць, скорочень і термінів (цей аркуш може бути відсутнім у документі);

– текстову частину документа.

Зверніть увагу. Нумеруються всі сторінки документа, починаючи з титульного аркуша. Проставляються номери, тільки починаючи з другої сторінки змісту. Номер сторінки записується у верхньому її колонтитулі справа.

На всіх сторінках (починаючи з анотації) у верхньому колонтитулі посередині проставляється шифр документа.

Увага: при описі програмних документів у пунктах 5.3.2 – 5.3.7 буде подано склад основної частини відповідного документа, а курсивом – приклади, що можуть бути використані студентами як зразки при розробці даного документа.

Специфікація

Специфікація розробляється згідно з вимогами ЄСПД ГОСТ 19.202-78 [5]; є основним програмним документом для розроблюваних програмних продуктів; розробляється на форматних аркушах (рис. 3) і, по суті, є переліком документів, що розроблені на програмний виріб.

Позначення	Назва	Примітка



80	70

Рисунок 3 – Форма специфікації

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

Лист затвердження будь-якого програмного документа у специфікації записується окремим рядком.

У графі «Позначення» указують шифри розроблених документів програми, у графі «Назва» – назву і вид документа на дану програму та повну назву програми, у графі «Примітка» – додаткові відомості про програму.

Текст програми

Оформлення тексту програми регламентуються ЄСПД ГОСТ 19.401-78 [6], код - 12.

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

Основна частина документа повинна складатися з текстів одного або декількох розділів, яким присвоєні назви. У випадку наявності більше одного розділу необхідно передбачити Зміст документа.

Текст кожного програмного файла починається з «шапки», у якій указується: назва програми, автор, дата створення програми, номер версії, дата останньої модифікації. У додатку Д подано приклад тексту програми.

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

Документ Опис програми регламентується ЄСПД ГОСТ 19.402-78 [7], код - 13.

Основна частина документа складається із вступу й таких розділів:

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

– опис логічної структури,

– умови застосування;

– вхідні та вихідні дані;

– склад і функції;

– виклик і завантаження.

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

Наприклад: Програма «Інформаційно-пошукова система» призначена для робітників служби …, може використовуватися в установах …, реалізована на мові програмування ….

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

Наприклад: Програма призначена для розв’язання завдань пошуку... Програма використовується самостійно (не вимагає інших програм). Користувач має можливість знайти..., відредагувати дані про …(додати, видалити, змінити вже існуючі), переглянути дані про ….

У розділі «Опис логічної структури» вказують:

– опис структури програми та її основних частин.

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

– відомості про мову програмування;

– опис вхідних і вихідних даних для кожної зі складових частин;

– опис логіки складових частин.

При описі структури програми та її основних частин можна вказати, наприклад, таке:

До складу програми входять наступні модулі:

– інтерфейсний;

– базового класу CbazeClass;

– класу спадкоємця Cavto;

– класу - колекції CAvtoServise.

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

Програма складається із чотирьох модулів: інтерфейсного та модулів класів. Інтерфейс побудований на діалозі типу «меню». Інтерфейсний модуль керує взаємодією.... Модуль базового класу BazeClass містить опис... Він є базовим в ієрархії класів... і т.д.

Коли подаються відомості про мову програмування можна вказати таке, наприклад:

Програма написана мовою... з використанням компілятора....

При опису вхідних і вихідних даних для кожної зі складових частин вказують, наприклад:

Вхідними даними для функції читання даних з файла є текстовий файл, що містить дані про …. Вихідними даними є:

- двонаправлений список з головним та хвостовими елементами ….

При опису логіки складових частин потрібно навести опис структури програми. Приклад структури програми подано у додатку Е.

При опису логіки програми необхідна прив'язка до тексту програми.

У розділі «Умови застосування» вказуються умови, які необхідні для виконання програми, наприклад:

Програма експлуатується на IBM-сумісних ПК під керуванням ОС Windows 2000/XP/2003/Vista. Для роботи в діалоговому режимі використається екран монітора, клавіатура та маніпулятор типу «миша». Вхід-ні дані зберігаються на зовнішніх носіях CD-R/RW, FLASH-RAM або HDD.

У розділі «Вхідні та вихідні дані» вказують:

Вхідними даними для програми є текстовий файл, що містить дані про …. Вихідними даними є:

– виведена на екран текстова інформація про …;

– текстовий файл – результат редагування даних.

У розділі «Склад і функції» вказують опис складу й функції програми, застосовуваних методів розв’язання завдань.

У розділі «Виклик і завантаження» можна вказати, наприклад, так:

Завантаження програми здійснюється набором у командному рядку DOS імені завантажувального файла – INFO.EXE з можливою вказівкою імені файла даних.

⇐ Предыдущая 123 4 5 6 7 8 9 Следующая ⇒