конспект лекцій (ТСПП). Конспект лекцій з дисципліни 07 технологія створення програмних продуктів напряму 050101 Компютерні науки
 Скачать 14.87 Mb.
|
11.7.Опис програми. Записка пояснення.Опис програми (код виду документу - 13) повинен містити відомості про логічну структуру і функціонування програми. Відомість експлуатаційних документів (код виду документу - 20) повинна містити перелік експлуатаційних документів на програму, до яких відносяться документи з кодами 30, 31, 32, 33, 34, 35, 46. Необхідність цього документу також визначається на етапі розробки і затвердження технічного завдання. Формуляр (код виду документу - 30) повинен містити основні характеристики програмного забезпечення, комплектність і відомості про експлуатацію програми. Опис застосування (код виду документу - 31) повинен містити зведення про призначення програмного забезпечення, сферу застосування, вживані методи, клас вирішуваних завдань, обмеження для застосування, мінімальної конфігурації технічних засобів. Керівництво системного програміста (код виду документу - 32) повинне містити відомості для перевірки, забезпечення функціонування і налаштування програми на умови конкретного застосування. Керівництво програміста (код виду документу - 33) повинне містити зведення для експлуатації програмного забезпечення. Керівництво оператора (код виду документу - 34) повинне містити зведення для забезпечення процедури спілкування оператора з обчислювальною системою в процесі виконання програмного забезпечення. Опис мови (код виду документу - 35) повинен містити опис синтаксису і семантики мови. Керівництво по технічному обслуговуванню (код виду документу - 46) повинне містити відомості для застосування тісто вых і діагностичних програм при обслуговуванні технічних засобів. Програма і методика випробувань (код виду документу - 51) повинні містити вимоги, що підлягають перевірці при випробуванні програмного забезпечення, а також порядок і методи їх контролю. Записка (код виду документу - 81) пояснення повинна містити інформацію про структуру і конкретні компоненти програмного забезпечення, у тому числі схеми алгоритмів, їх загальний опис, а також обгрунтування прийнятих технічних і техніко-економічних рішень. Складається на стадії ескізного і технічного проектів. Інші документи (коди виду документу - 90-99) можуть складатися на будь-яких стадіях розробки, т. е. на стадіях ескізного, технічного і робочого проектів. Записка пояснення Записка пояснення повинна містити усю інформацію, необхідну для супроводу і модифікації програмного забезпечення, : відомості про його структуру і конкретні компоненти, загальний опис алгоритмів і їх схеми, а також обгрунтування прийнятих технічних і техніко-економічних рішень. Зміст записки пояснення за стандартом (ГОСТ 19.404-79) повинен включати наступні розділи:
У розділі Введення вказують найменування програми і документу, на підставі якого ведеться розробка. У розділі Призначення і сфера застосування вказують призначення програми і дають коротку характеристику сфери застосування. Розділ Технічні характеристики повинен містити наступні підрозділи:
У розділі Очікувані техніко-економічні показники вказують техніко-економічні показники, що обгрунтовують перевагу вибраного варіанту технічного рішення. У розділі Джерела, використані при розробці, вказують перелік науково-технічних публікацій, нормативнотехнических документів і інших науково-технічних матеріалів, на які є посилання в початковому тексті. Записка пояснення складається професіоналами в області розробки програмного забезпечення для фахівців того ж рівня кваліфікації. Отже, в ній доречно використовувати спеціальну термінологію, посилатися на спеціальну літературу і т. п. 11.8.Керівництво системного програміста. Вимоги до змісту і оформлення.Посібник користувача Нині часто використовують ще один експлуатаційний документ, в який частково входить керівництво системного програміста, програміста і оператора. Цей документ називають Посібником користувача. Поява такого документу стала наслідком широкого поширення персональних комп'ютерів, працюючи на яких користувачі поєднують у своєму обличчі трьох вказаних фахівців. Складання документації для користувачів має свої особливості, пов'язані з тим, що користувач, як правило, не є професіоналом в області розробки програмного забезпечення. У книзі С. Дж. Гримм дані рекомендації по написанню подібної програмної документації :
Посібник користувача, як правило, містить наступні розділи:
Розділ Загальні відомості про програму зазвичай містить найменування програмного продукту, короткий опис його функцій, реалізованих методів і можливих сфер застосування. Розділ Установка зазвичай містить детальний опис дій з установки програмного продукту і повідомлень, які при цьому можуть бути отримані. У розділі Запуск, як правило, описані дії із запуску програмного продукту і повідомлень, які при цьому можуть бути отримані. Розділ Інструкції по роботі зазвичай містить опис режимів роботи, форматів введення-виведення інформації і можливих налаштувань. Розділ Повідомлення користувача повинен містити перелік можливих повідомлень, опис їх змісту і дій, які необхідно зробити по цих повідомленнях. |