2.5.5 Зміст документу «Порадник користувача»

Вимоги до структури та змісту документу «Порадник користувача» встановлені ГОСТ 19.505-79.

Документ «Порадник користувача» складається з листа затвердження, титульного листа, обов’язкової інформаційної частини («Анотація» і «Зміст»), та основної частини (власне опису застосування програми), яка складається з наступних розділів:

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

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

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

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

Залежно від особливостей програми, допускається вводити додаткові розділи та об’єднувати окремі розділи.

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

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

В розділі «Виконання програми» повинні бути приведені послідовності дій користувача, що забезпечують виконання завантаження, пуску, виконання та завершення програми, наведені описи функцій, форматів, можливих варіантів команд, що загалом складають інтерфейс користувача.

Розділ «Повідомлення оператору» містить тексти повідомлень, що їх видає програма під час виконання, опис їх змісту та відповідних дій користувача, в тому числі у випадках помилок та збоїв, повторних запусків програми тощо.

Зміст розділів можливо ілюструвати довідковими матеріалами (ілюстраціями, таблицями, схемами, графіками, прикладами тощо).

2.5.6 Зміст інформаційної частини програмних документів

Анотація ПД відноситься не до всього ДП, а тільки до ПП. В анотації наводяться відомості про програмний комплекс, які включають у себе засоби розробки, переваги та рекомендації до застосування.

Зміст ПД включає перелік записів про структурні елементи документа, у кожний з яких входять:

• позначення структурного елемента (номер розділу, підрозділу і т.п.);

• найменування структурного елемента;

• номер сторінки.

Розділ 3. Зміст основної частини дипломного проекту

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

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

ПЗ до ДП повинна у стислій та чіткій формі розкривати творчий задум проекту, містити аналіз сучасного стану проблеми, методів вирішення завдань проекту, обґрунтування їх оптимальності, методики та результати розрахунків, опис проведених експериментів, аналіз їх результатів і висновки з них; містити необхідні ілюстрації, ескізи, графіки, діаграми, таблиці, схеми, малюнки тощо. В ній зайві загальновідомі положення, детальні описи, виведення складних формул тощо.

В ПЗ не слід надавати відомі визначення (наприклад, що таке СУБД та обґрунтування вимог, які до неї висуваються), описи загальновідомих методів (достатньо посилання на літературу), не слід описувати, як треба проектувати програму, розробляти алгоритм, тестувати програму і т. і., але треба описувати проектування конкретної програми, розробку конкретних алгоритмів, тестування розробленої програми; треба викласти також, які при цьому автором приймалися рішення і на підставі яких саме міркувань.

Загальними вимогами при викладенні суті ДП є логічна послідовність викладення матеріалу, чіткість, переконливість аргументації, стислість і точність формулювань, конкретність.

За своїм змістом ПЗ повинна відповідати ЗДП.

ПЗ містить у собі ряд обов’язкових складових частин, перелік яких та вимоги до яких встановлюються в розділі 2 цих методичних вказівок та конкретизуються керівником проекту відповідно до профілю спеціальності.

ПЗ відноситься до текстових документів, які містять інформацію, подану в основному технічною мовою, та графічну інформацію у вигляді ілюстрацій. Ілюстраціями можуть бути фрагменти схем, графіки, фотографії тощо.

Цифрову інформацію частіше представляють у вигляді таблиць. Частина інформації може бути представлена у вигляді формул.