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

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

Згідно вимог ГОСТ 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 з можливою вказівкою імені файла даних.

Керівництво оператора

Керівництво оператора розробляється згідно з вимогами ЄСПД ГОСТ 19.505-79 [8], код – 34.

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

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

– умови виконання;

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

– повідомлення оператору.

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

Для нормального функціонування програми необхідні комп‘ютери з ОС Windows. Особливих вимог до розміру RAM чи потужності процесора немає. Обсяг жорсткого диску має бути достатнім для збереження вхідних та вихідних даних.

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

– послідовність дій оператора, що забезпечують завантаження, запуск, виконання і завершення програми;

– опис функцій, формату і можливих варіантів команд, за допомогою яких оператор здійснює завантаження і керує виконанням програми, а також можливі відповіді на ці команди.

Тут може вказуватися, наприклад, таке:

Для запуску програми призначено файл AvtoServise.exe. Після запуску програми видається меню, як на рис. 1.

…

Для пошуку даних необхідно ввести номер команди 6.

Рисунок 1 – Головне меню програми

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

No access on-line data – видається при пошуку у випадку, коли дані в пам'яті відсутні (не вводилися і не зчитувалися). Необхідно загрузити дані і повторити команду.

Accept search smage – видається за наявності даних для пошуку. Ввести з клавіатури ключ пошуку. …

Допускається зміст розділів ілюструвати прикладами, що пояснюють викладені тези, таблицями, схемами, графіками.

Поиск по сайту: