2 Оформлення пояснювальної записки

Пояснювальна записка курсового проекту виконується рукописним або машинним способом на одній стороні аркуша формату А4 (ГОСТ 2.301). При рукописному способі проект виконується чорнилами або пастою чорного кольору.

При машинному способі допустимо виконувати оформлення курсового проекту на друкуючих та графічних пристроях виведення персональних комп’ютерів /ГОСТ 2.004-88/ з додержуванням правил Єдиної системи конструкторської документації та Єдиної системи програмної документації.

Аркуш повинен мати поле таких розмірів:

- верхнє - 25мм;

- праве -10 мм;

- нижнє - 15 мм;

- ліве -20 мм.

Обсяг пояснювальної записки курсового проекту не повинен перебільшувати 15 – 20 аркушів без врахування лістингу програми.

Структура пояснювальної записки:

- лист затвердження;

- завдання на курсовий проект;

- титульний лист;

- зміст;

- основна частина;

- висновок;

- список використаних джерел;

- додатки.

Зміст пояснювальної записки курсового проекту :

1 Вступ

2 Постановка задачі

2.1 Характеристика предметної області

2.2 Вимоги до програми

2.3 Структура вхідних даних

2.4 Структура вихідних даних

3 Комп’ютерна система

3.1 Технічні характеристики комп’ютера та зовнішніх пристроїв

3.2 Вибір програмних засобів та операційної системи

4 Об’єктно-орієнтоване проектування

4.1 Інтерфейс програми

4.2 Алгоритм рішення задачі

5 Програмування та тестування

5.1 Розробка програми

5.2 Етапи відладки

5.3 Типи помилок

Висновки

Список використаних джерел

Додаток А Схема алгоритму програми

Додаток Б Лістинг програми

Додаток В Роздрук результатів роботи програми

Пояснювальна записка повинна бути виконана у відповідності до стандартів ЄСКД та ЄСПД

ГОСТ 2.004-88 ЕСКД. Общие требования к вьполнению конструкторских и технологических документов на печатающих и графических устройствах вывода ЭВМ.

ГОСТ 2.301-68 ЕСКД. Форматы.

ГОСТ 19.106-78 ЕСПД. Требования к программным документам, вьполненным печатным способом.

ДСТУ 3008-95 Документація. Звіти у сфері науки і техніки. Структура і правила оформлення.

ГОСТ 19.701-90 (ИСО 5807 -85) ЕСПД. Схемы алгоритмов, программ, данных и систем. Условные обозначения и правила выполнения.

ИСО 5807-85. Схемы алгоритмов, программ, данных и систем. Условные обозначения и правила выполнения

ГОСТ 2.105-95 ЕСКД. Общие требования к текстовым документам.

СОУ 02:2008 Правила оформлення пояснювальної записки до дипломного та курсового проектів (робіт). Загальні відомості.

СОУ 03:2005. Нормоконтроль курсових та дипломних проектів (робіт). Загальні відомості.

3 Зміст розділів пояснювальної записки

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

Вступ повинен містить загальну характеристику курсового проекту

Призначення вступу - оцінка сучасного стану розв'язуваної науково-технічної проблеми, її актуальність.

Вступ розташовують як окремий розділ.

В даному розділі повинно бути чітко викладено наступне:

• оцінка сучасного стану розв'язуваної науково-технічної проблеми;

• мета і задачі курсового проекту;

• необхідність розробки проблеми і галузь застосування;

• обґрунтування актуальності даного проекту з формулюванням ступеню її новизни,

• обмеження розробки і методів рішення,

• можуть наводитися дані аналізу передових досягнень вітчизняної й закордонної науки, техніки, виробництва й досліджуваної області.

Приклад

Оцінка сучасного стану розв'язуваної науково-технічної проблеми.

Прикладне програмне забезпечення, що розроблюється, є місце користувача-фахівця тієї або іншої професії, обладнане засобами, необхідними для автоматизації виконання їм визначених функцій. Такими засобами, як правило, є персональний комп’ютер, що доповнюється по мірі необхідності іншими допоміжними електронними пристроями а саме: дисковими накопичувачами, друкуючими пристроями, оптичними пристроями, що читають, або зчитування штрихового коду, пристроями графіки, засобами сполучення іншим прикладним програмним забезпеченням і з локальними обчислювальними мережами і т.д.

Найбільше поширення в світі набуло програмне забезпечення на базі професійних комп’ютерів з архітектурою IBM PC.

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

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

Для реалізації ідеї розподіленого управління було потрібно створення для кожного рівня управління і кожної наочної області автоматизованих систем на базі професійних персональних комп'ютерів. Наприклад, у сфері економіки на такому можна здійснювати планування, моделювання, оптимізацію процесів, ухвалення рішень в різних інформаційних системах і для різних поєднань завдань. Для кожного об'єкту управління необхідно передбачати програмне забезпечення, відповідне його значенню. Проте принципи створення будь-якого прикладного програмного забезпечення повинні бути загальними:

• системність.

• гнучкість.

• стійкість.

• ефективність.

Обмеження розробки і методи рішення

При роботі над курсовим проектом були розроблені функції і процедури для перевірки і обробки дати і рядків. Вони винесені в окремий модуль і можуть бути застосовані при рішенні нових задач.

Також були закодовані алгоритми для специфічної роботи з періодами часу при роботі з місяцями, кварталами і т.п.

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

Необхідно вказати де і ким буде використовуватися дана програма і які перспективи її удосконалення.

У розділі «2 Постановка задачі» необхідно описати наступні підрозділи

Підрозділ 2.1 «Характеристика предметної області».

У даному підрозділі необхідно навести характеристику предметної області та об’єкта автоматизації (ГОСТ). Призначення комплексу задач - повинно бути викладено експлуатаційне та функціональне призначення програмного виробу.

Експлуатаційне призначення - це мета використання майбутнього програмного виробу.

Функціональне призначення - це засоби досягнення поставленої мети.

Загальний опис задачі повинен містити:

• призначення розроблювального програмного забезпечення;

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

• структуру розроблювального програмного забезпечення та призначення його частин;

• опис функціонування програмного продукту та його частин;

• обмеження розробки, тобто які процеси не будуть автоматизовані;

• умови при яких припиняється рішення комплексу задач автоматизованим способом ;

• розподіл дій між персоналом та технічними засобами при різних рішеннях комплексу задач;

• визначається клас задачі та специфічні особливості реалізації цього класу на комп’ютері.

Клас задачі може бути наступним:

• задача лінійного програмування;

• інформаційна система;

• система масового обслуговування;

• автоматизована система управління;

• автоматизоване робоче місце;

• експертні системи та системи підтримки прийняття рішень.

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

Необхідно вказати яке лінгвістичне забезпечення (сукупність мовних засобів) буде використано для розробки прикладного програмного забезпечення.

Наприклад - якщо розроблювальне прикладне програмне забезпечення являє собою розробку Web-застосувань то перелік задач може бути наступним:

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

• позначити групи користувачів інформаційною системою.

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

• створити Web-сайт про роботу фірми з наданням інформації про матеріали, що є на складі, і можливістю оформлення замовлення на постачання товару з автоматичною генерацією рахунку на оплату.

Перелік задач може бути наступним:

• інформаційно-довідкове обслуговування кінцевих користувачів;

• розвинений діалог між користувачем і комп’ютером при розв’язуванні поставлених задач й у процесі прийняття управлінських рішень;

• формування і ведення локальних баз даних і використання інформації спільної бази даних;

• надання різних сервісних послуг користувачу на його робочому місці.

Підрозділ 2.3 «Структура вхідних даних» повинен мати таблицю 3.1, в якій наведена структура даних:

Приклад

Таблиця 3.1 Структура вхідних даних

Ідентифікатор	Тип	Діапазон значень	Пояснення
Rik_nar	int	1900…2100	Рік народження

Також необхідно обґрунтувати вибір змінних та зазначити вимоги до даних (набор значень, коментарі, порядок введення та виведення і т.д.) та як вони програмно вирішуються.

Підрозділ 2.4 «Структура вихідних даних» повинен мати таблицю, в якій наведена структура даних:

Приклад

Таблиця 3.2 Структура вихідних даних

Ідентифікатор	Тип	Діапазон значень	Пояснення
Reciving	boolean	True, false	Змінна умови одержання файлу

Розділ 3 «Комп’ютерна система» повинен складатися з двох частин.

У підрозділі 3.1 «Технічні характеристики комп’ютера та зовнішніх пристроїв» необхідно перелічити всі технічні характеристики комп'ютера, на якому розроблявся курсовий проект: тип комп'ютеру, об'єм оперативної пам'яті, швидкодію, тип монітору, тип принтеру. Також розділ повинен містити перелік характеристик технічних засобів, на яких розроблена студентом програма може функціонувати без втрати своїх можливостей

Підрозділ 3.2 «Вибір програмних засобів та операційної системи» повинен містити обгрунтування вибору мови програмування, її версії, необхідно вказати, які саме вимоги, визначені при постановці задачі, обґрунтувати вибір саме цієї мови програмування. Вказати всі переваги обраної мови та її недоліки. Перелічити характеристики мови. Необхідно внавести перелік програмного забезпечення для встановлення.

На початку даного розділу також слід дати визначення поняття «Програмне забезпечення» і привести його структуру.

Обґрунтування проектних рішень з програмного забезпечення полягає у формуванні вимог до системного (загального) і спеціальному прикладного програмного забезпечення й у виборі на основі цих вимог відповідних компонентів програмного забезпечення.

При обґрунтуванні вибору доцільно:

- обґрунтувати вибір операційної системи, вказати фактори, що впливають на вибір конкретного класу і його версії;

- обґрунтувати вибір СКБД.

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

Вибір засобів розробки необхідно аргументувати, порівнюючи їх з аналогічними засобами, що існують на ринку.

План обґрунтування доцільно зробити наступним:

- виділити перелік необхідних елементів програмного забезпечення;

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

- здійснити порівняння можливих альтернатив і зробити обґрунтований вибір;

- або показати те, що елементів, описаних раніше при описі програмно-технічної архітектури підприємства буде досить.

Розділ 4 «Об’єктно-орієнтоване проектування» складається з двох підрозділів.

У підрозділі 4.1 «Інтерфейс програми» необхідно навести основні вимоги до інтефейсу програми.

Інтерфейс користувача є своєрідним комунікаційним каналом, по якому здійснюється взаємодія користувача і комп'ютера.

Кращий, призначений для користувача інтерфейс - це такий інтерфейс, якому користувач не повинен приділяти багато уваги, майже не помічати його. Такий інтерфейс називають прозорим - користувач ніби дивиться крізь нього на свою роботу.

Щоб створити ефективний інтерфейс, що робив би роботу з програмою приємною, треба розуміти, які завдання будуть вирішувати користувачі за допомогою програми і які вимоги до інтерфейсу можуть виникнути у користувачів.

У загальних принципах проектування інтерфейсу виділяють такі основних положення:

- програма повинна допомагати виконати завдання, а не ставати завданням для користувача;

- при роботі з програмою користувач не повинен відчувати себе необізнаним.

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

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

У підрозділі 4.2 «Алгоритм рішення задачі» необхідно згідно до розділу «Постановка задачі» описати алгоритм рішення. Розробка й обґрунтування алгоритмів розв'язання поставленої задачі містять побудову алгоритму, що реалізує обраний метод розв'язання задачі, обґрунтування його структури, що відображає основні операції процесу обробки даних на комп’ютері, схемне зображення алгоритму і його опис. Крім того, здійснюється оцінка алгоритму і визначення його якісних показників, порівняння з існуючими алгоритмами. Схемне зображення алгоритмів і програм виконується відповідно до

ГОСТ 19.701-90.

Опис алгоритму варто виконувати в короткій формі з указівкою призначення кожного елемента або групи елементів блоків.

У випадку застосування об’єктно-орієнтованого підходу в якості структурної схеми може фігурувати ієрархія класів (об’єктів).

Приклад:

procedure TForm1.ToolButton1Click(Sender: TObject); - Вивід форми для розрахунку загальної вартості витрат;

або

Головна програма Program виконує ..., викликає ...

Процедура Ргос1 виконує ..., викликає ...

Розділ 5 «Програмування та тестування» повинен складатися з трьох частин.

У підрозділі 5.1 «Розробка програми» необхідно вказати всі етапи розробки програми. Якщо для рішення поставленої задачі необхідно використовувати базу даних то при створенні програми в першу чергу визначається структура бази даних, що включає в себе визначення ієрархії, зв’язків, індексів, назва полів та їх оптимальні розміри. Далі розробляються функції і підпрограми, що відповідають за введення та контроль даних, узгоджуються з вхідними документами. Зовнішнє розташування полів має максимально відповідати структурі вхідних даних і побажанням користувача або замовника. При обробці даних необхідно звернути увагу на неприпустимість зависання програми у разі будь-яких неправильних дій користувача Всі помилкові дії повинні супроводжуватися повідомленнями, зрозумілими користувачеві, а їх відповідь повинна оброблятися усередині програми. При розробці вихідних форм, тобто звітів раціонально буде використання генератора звітів з подальшим підключенням їх до проекту. Далі створюється проектний файл, що включає в себе основну програму, підпрограми, процедурний файл, а також при необхідності установчий файл, який визначає шляхи файлів, тимчасові директорії, додаткові установки. Після складання (побудови) проекту створюється ЕХЕ-файл, готовий до старту програми. При необхідності створюється ВАТ-файл, який використовує не тільки виклик ехе-файлу, а й деякі установки та шляхи а також параметри, пов’язані з конкретним користувачем, особливо якщо поставлена задача повинна бути впроваджена в мережевому режимі.

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

Опис контрольного прикладу повинен включати опис:

• тестових даних, які необхідні для перевірки працездатності основних функцій реалізованого проекту (дані для заповнення довідників, дані для заповнення файлів оперативної інформації). Наведені тестові дані повинні бути введені у відповідні поля форм і показані в додатку (екранні форми з тестовими даними);

• процесу обробки тестових даних (різні повідомлення та інші елементи діалогу, який виникає в процесі обробки). Даний опис також відображується у додатку;

• результатів обробки тестових даних (розраховані показники, сформовані відомості, звіти і т.п.). Результати так само повинні бути відображені у відповідному додатку.

Особливу увагу слід звернути на цілісність контрольного прикладу і правильність отриманих результатів обробки тестових даних, а саме - отримані дані повинні бути перевірені на правильність розрахунку за наведеними формулами.

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

У підрозділі 5.3 «Типи помилок» описуються основні типи помилок, які зустрічались на етапах програмування, тестування та відладки програми. Окрім цього необхідно описати основні помилки яких може припуститися користувач при роботі з програмою.

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

У висновках наводиться коротка викладка показників, отриманих при розробці проекту; вказуються напрями подальшої роботи над проектом.

Структурний елемент «Список використаних джерел» містить перелік літератури та ін. джерела, які використовувалась для виконання курсового проекту.

У додатку «Додаток А. Схема алгоритму програми» містить схему алгоритму програми, виконану відповідно до ГОСТ 19.701-90.

У додатку «Додаток Б Лістинг програми» містить лістинг програми.

У додатку «Додаток В Роздрук результатів роботи програми» містить роздрук екранних форм програми, отриманих у результаті виконання контрольного прикладу.