Код – 81. Оформлення документа Пояснювальна записка регламентуються ЄСПД ГОСТ 19.404-79.
Документ повинен містити вступ і наступні розділи:
- призначення й область застосування,
- постановку завдання до розробки,
- опис вхідних та вихідних даних,
- опис складу технічних та програмних засобів,
- список використаних джерел інформації.
У Вступі можна дати, наприклад, таку інформацію:
Інформаційно-довідкові системи – це такі програмні оболонки, що призначені для керування базами даних і використовуються, наприклад, для ведення статистики, складання каталогів, тощо. Так, інформаційні системи підтримують ведення…..
У розділі “Призначення й область застосування” вказується призначення програми, дається характеристика області застосування.
Наприклад. Призначення розробки – оперування даними про...; дозволяє виконувати пошук за зразком, сортування, додавання даних, їх видалення, тощо. Може використовуватися в …
У розділі “Постановка завдання до розробки” поміщають наступне:
|
|
· аналітичний огляд інформації з порушеного питання;
· завдання на розробку програми;
· опис застосовуваних математичних методів, обґрунтовується вибір сучасної технології програмування, вказується середовище програмування;
· відповідно до обраного шляху проектування словесно описується обрана структура даних, розроблена структура програми та алгоритм її функціонування. Обґрунтовується коректність алгоритму або окремих його фрагментів;
· аналогічно описуються розроблювані підпрограми.
Аналітичний огляд інформації в даному КП можна почати так:
В основі функціонування інформаційно-довідкових систем лежить обробка інформації. Режими її обробки можуть бути такими: пакетний, діалоговий, реального часу [2].
Діалоговий режим забезпечує безпосередню взаємодію користувача з системою. Ініціатором діалогу може бути як користувач, так і ЕОМ. В останньому випадку на кожному кроці користувачу повідомляється, що треба робити. …В роботі буде реалізовано….
Дані, що обробляються, в оперативній пам’яті можуть зберігатися у вигляді масиву або лінійного (одно- чи двонаправленого) списку[1]. …
До переваг масиву можна віднести …, до недоліків - ….
До переваг списку можна віднести …, до недоліків - ….
Виходячи з …в розроблюваній програмі для представлення даних буде реалізовано ….
В завданні на розробку, виходячи з аналітичного огляду, конкретизується перелік завдань, щодо розробки.
При виборі мови і середовища програмування можна зазначити таке:
Об’єктно-орієнтоване програмування має такі переваги: …. Мова програмування … забезпечує …. Тому для розробки програми обрано мову програмування …, а середовище програмування - ….
|
|
При розробці структур даних слід виходити з заданого об’єкту та його властивостей. Тут можна запропонувати таке:
Для опису властивостей заданого об’єкту має сенс розробити структуру TAvto з наступними полями:
Змінна | Тип | Опис |
name [20] | char | назва |
year | int | рік випуску |
Дані про всі авто записувати у списку, для чого ввести структуру TList з такими полями:
Змінна | Тип | Опис |
info | TAvto | інформаційне поле елемента списку |
next | TList *; | адреса наступного елемента списку |
Для роботи із списком розробити клас CList з закритим атрибутом
TList *head; - адреса голови списку
і відкритими методами:
Назва функції | Тип результату | Опис |
ReadFile() | void | введення даних з файлу |
ReadConsole() | void | введення даних з клавіатури |
WriteFile() | void | запис даних у файл |
WriteMonitor() | void | видача даних на екран монітору |
Edit() | void | редагування даних |
Poisk() | void | пошук даних за зразком |
Help() | void | виведення підказки |
При опису структури програми можна вказати, наприклад, таке:
Програма складається з наступних модулів:
- інтерфейсного, містить функцію main і функції реалізації діалогу;
- модулю, що містить опис класу CAvto,
- модулю, що містить опис класу - колекції CAvtoServise.
При опису функцій слід висвітлити таке:
· призначення,
· посилання на схему алгоритму функції (як що є),
· порядок роботи.
При опису головної функції main можна зазначити, наприклад, таке:
Функція main координує роботу усіх функцій програми.
Схема алгоритму подана на рис.1.
Порядок роботи: В циклі видається меню, вводиться команда оператора (блок 1), яка розпізнається в блоці 2 і в залежності від значення команди керування передається відповідній функції. Програма припиняє роботу після вводу команди «8».
В розділі “Опис вхідних та вихідних даних” подається обґрунтований вибір методу організації вхідних і вихідних даних, перераховується необхідний набір і джерело вхідних даних, спосіб їх одержання розроблювальною програмою.
Наприклад, Вхідні дані можуть вводитися оператором з клавіатури в такій послідовності …, або з типізованого файлу.
Для вихідних даних аргументується вибір носія для їх зберігання та спосіб відображення для користувача.
Вихідні дані зберігаються в типізованому файлі. Типізований файл обрано тому, що у порівнянні з текстовим файлом він має такі переваги …. До недоліків слід віднести таке ….
В розділі “ Список використаних джерел інформації ” наводять перелік науково-технічних публікацій, нормативно-технічних документів і інших науково-технічних матеріалів. Докладна інформація про надання переліку джерел подана в п. 6.2.9 даних вказівок.
Увага. В разі необхідності ГОСТ дозволяє об’єднувати окремі розділи документу і додавати інші. В Додатку Г подано приклад змісту Пояснювальної записки.