- •Методичні вказівки
- •Перелік умовних позначень
- •1 Завдання до виконання рз
- •2 Вимоги до змісту та обсягу рз
- •3 Порядок та термін виконання
- •4 Програмні документи
- •4.1 Види програмних документів
- •4.2 Шифри документів
- •4.3 Опис програмних документів
- •4.3.1 Загальні вимоги
- •4.3.2 Специфікація
- •4.3.3 Текст програми
- •4.3.4 Опис програми
- •4.3.5 Керівництво оператора
- •4.3.6 Програма й методика випробувань
- •4.3.7 Пояснювальна записка
- •4.3.8 Оформлення схем алгоритмів у програмній документації
- •5 Основні вимоги до оформлення текстових документів
- •5.1 Загальні вказівки
- •5.2 Правила оформлення текстових документів
- •5.2.1 Нумерація сторінок
- •5.2.2 Побудова тексту
- •5.2.3 Викладення тексту
- •5.2.4 Оформлення ілюстрацій
- •5.2.5 Побудова таблиць
- •5.2.6 Написання формул
- •5.2.7 Оформлення приміток
- •5.2.8 Посилання на нормативну літературу
- •5.2.9 Оформлення списку джерел інформації
- •5.2.10 Оформлення додатків
- •6.1.1 Створення проекту
- •6.1.2 Додавання файла до вже існуючого проекту
- •6.1.3 Компіляція програми
- •6.1.4 Виконання програми
- •6.2.1 Створення проекту консольного додатка
- •6.2.2 Компіляція й виконання програми
- •6.3.1 Створення нового проекту
- •6.3.2 Додавання файла до проекту Додавання файла до проекту виконується в такий спосіб.
- •6.3.3. Компіляція програми та виконання програми
- •Список джерел інформації
- •Додаток а
- •Додаток г Приклад вмісту специфікації
- •Додаток д Приклад тексту програми
- •Додаток е Приклад структури програми
- •Додаток ж
- •61002, Харків, вул. Фрунзе, 21
4.3.5 Керівництво оператора
Керівництво оператора розробляється згідно з вимогами ЄСПД ГОСТ 19.505-79 [8], код – 34.
Основна частина документа складається з таких розділів:
призначення програми;
умови виконання;
виконання програми;
повідомлення оператору.
В розділі «Умови виконання» вказуються умови, які необхідні для виконання програми, а саме: мінімальний або максимальний склад апаратурних і програмних засобів, обсяг оперативної пам’яті, жорсткого диска тощо. Але може бути і таке, наприклад:
Для нормального функціонування програми необхідні комп‘ютери з ОС Windows. Особливих вимог до розміру RAM чи потужності процесора немає. Обсяг жорсткого диску має бути достатнім для збереження вхідних та вихідних даних.
У розділі «Виконання програми» вказують:
послідовність дій оператора, що забезпечують завантаження, запуск, виконання і завершення програми;
опис функцій, формату і можливих варіантів команд, за допомогою яких оператор здійснює завантаження і керує виконанням програми, а також можливі відповіді на ці команди.
Тут може вказуватися, наприклад, таке:
Для запуску програми призначено файл AvtoServise.exe. Після запуску програми видається меню, як на рис. 1.
…
Для пошуку даних необхідно ввести номер команди 6.
Рисунок 1 – Головне меню програми
У розділі «Повідомлення оператору» надають перелік текстів повідомлень, що видаються в ході виконання програми, опис їх змісту і відповідні дії оператора, наприклад, дії оператора у випадку перебою, можливості повторного запуску програми і т.п. Наприклад,
No access on-line data – видається при пошуку у випадку, коли дані в пам'яті відсутні (не вводилися і не зчитувалися). Необхідно загрузити дані і повторити команду.
Accept search smage – видається за наявності даних для пошуку. Ввести з клавіатури ключ пошуку. …
Допускається зміст розділів ілюструвати прикладами, що пояснюють викладені тези, таблицями, схемами, графіками.
4.3.6 Програма й методика випробувань
Код – 51, Оформлення документа Програма й методика випробувань регламентуються ЄСПД ГОСТ 19.301-79 [9].
У цьому документі вказується опис того, що і як необхідно зробити, щоб переконатися в правильності роботи програми і її відповідності вимогам завдання на розробку.
Документ містить такі розділи:
об'єкт випробувань;
мета випробувань;
вимоги до програми та програмної документації;
порядок випробувань;
опис тестів та тестових прикладів;
оцінка результатів випробувань.
Для розділу «Об'єкт випробувань» може бути запропонований такий приклад: Об'єктом випробувань є програма AvtoServise, призначена для ….
У розділі «Мета випробувань» можна написати, наприклад, так:
Перевірка надійності функціонування програми.
У розділі «Вимоги до програми»можна вказати так, наприклад:
Функціонування програми не повинне призводити до перебою роботи операційної системи. Організація діалогу повинна передбачати захист від уведення некоректних даних.
Для розділу «Вимоги до програмної документації»можна запропонувати такий приклад:
Склад програмної документації, пропонованої на випробуванні: Опис програми (ЄСПД ГОСТ 19.402-78); Програма й методика випробувань (ЄСПД ГОСТ 19.301-79); Текст програми (ЄСПД ГОСТ 19.401-78).
У розділі «Порядок випробувань»потрібно вказати, наприклад, так:
Програма працює відповідно до умов експлуатації на IBM сумісних ПК з ОС Windows 2000/XP/2003/Vista.
Порядок проведення випробувань наступний:
Запуск програми здійснюється ... . Далі вибирається ... для чого натискається ... . Потім послідовно вибираються ...
У розділі «Опис тестових прикладів»можна написати так:
Для проведення випробувань пропонуються дані, що зберігаються у файлах ... . Вміст тестових файлів і результати роботи програми наведені в додатку ...
У розділі «Оцінка результатів випробувань»робиться висновок про відповідність об'єкта випробувань вимогам завдання.