Вимоги до змісту пояснювальної записки

Пояснювальна записка повинна містити наступні розділи:

- вступ. Даний розділ повинен містити інформацію про призначення та галузі застосування програми.

- постановка задачі. Даний розділ повинен включати вихідні дані по варіанту завдання, розгорнутий опис предметної області, термінологічний словник.

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

- керівництво користувача

-висновки

- бібліографія. Даний розділ повинен включати джерела, використані при розробці.

- додатки. Програми повинні містити програмний код розроблених класів.)

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

ВИМОГИ ДО ФОРМИ ПОЯСНЮВАЛЬНОЇ ЗАПИСКИ

Загальні вимоги

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

Записку виконують із розрахунку не більше 40 рядків на сторінці за умови рівномірного її заповнення і висотою літер і цифр не менше 1,8 мм. При написанні тексту необхідно додержуватись таких розмірів полів: верхнє, ліве і нижнє - не менше 20 мм, праве - не менше 10 мм.

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

Пояснювальна записка виконується машинним способом на одній стороні аркушу білого паперу формату А4 (210 х 297 мм) відповідно до ДСТУ 3008-95 "Документація. Звіти в сфері науки і техніки. Структура і правила оформлення" [2]. Наведемо деякі положення цього документу.

Структурні елементи та розділи

Треба розрізняти структурні елементи записки, такі як “РЕФЕРАТ”, “ЗМІСТ”, “ВСТУП”, “СУТЬ” і розділи записки. Деякі елементи, а саме “РЕФЕРАТ”, “ЗМІСТ”, “ВСТУП”, “ВИСНОВКИ”, “ПЕРЕЛІК ПОСИЛАНЬ”, створюють розділи записки і їхні найменування служать заголовками окремих розділів. Такі розділи не мають нумерації. Структурний елемент записки „СУТЬ” сам може поділятися на розділи, які нумеруються и мають власні заголовки.

Розділи можуть поділятися на підрозділи, пункти та підпункти.

Заголовки

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

Переноси слів у заголовку розділу не припускаються.

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

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

Нумерація сторінок

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

Нумерація розділів та підрозділів

Розділи, підрозділи, пункти, підпункти пояснювальної записки варто нумерувати арабськими цифрами. Розділи пояснювальної записки повинні мати порядкову нумерацію в межах суті пояснювальної записки і позначатися арабськими цифрами без крапки, наприклад, 1, 2, 3. Підрозділи повинні мати порядкову нумерацію в межах кожного розділу. Номери підрозділів складаються з номерів розділів і підрозділів, що розділяються крапкою, наприклад, 1.1, 1.2, 1.3.

Переліки

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

Приклад:

а) перша версія бібліотеки;

б) друга версія бібліотеки:

1) для персональних комп’ютерів;

2) для мобільних пристроїв;

в) третя версія бібліотеки.

Ілюстрації

Ілюстрації треба розташовувати в пояснювальній записці безпосередньо після тексту, у якому вони вперше згадуються, або на наступній сторінці. На всі ілюстрації повинні бути посилання в пояснювальній записці. Ілюстрації можуть мати назву, що розташовують під ілюстрацією. При необхідності під ілюстрацією ще розташовують пояснювальні дані. Ілюстрація позначається словом “Рисунок”, що разом із назвою поміщають після пояснювальних даних, наприклад, “Рисунок 2.1 - Схема алгоритму”. Ілюстрації необхідно нумерувати арабськими цифрами в межах розділу, за винятком ілюстрацій, наведених у додатках. Номер ілюстрації складається з номера розділу і порядкового номера ілюстрації, розділених крапкою. Якщо ілюстрація не вміщується на одній сторінці, можна переносити її на інші сторінки, при цьому назву ілюстрації розташовують на першій сторінці, пояснювальні дані - на кожній сторінці, і під ними вказують: “Рисунок, аркуш ”.

Таблиці

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

Формули і рівняння

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

Посилання

Посилання в тексті на джерела необхідно наводити в послідовності їх згадування в записці, вказуючи порядковий номер, виділений двома квадратними дужками, наприклад: [5].

Скорочення

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

Перелік посилань

Перелік посилань оформлюється як розділ пояснювальної записки з нової сторінки відповідно до вимог ГОСТ 7. 1-84 "Библиографическое описание документа. Общие требования и правила составления".

Для оформлення бібліографічних посилань, правильного запису загальноприйнятих скорочень рекомендується використовувати методичні вказівки [3], які складені з урахуванням відповідних стандартів.

 

Додатки

Додатки необхідно оформляти як продовження пояснювальної записки на наступних її сторінках, або в окремій частині, розташовуючи додатки в порядку появи посилань на них у тексті пояснювальної записки. Кожний додаток повинен починатися з нової сторінки і мати заголовок, надрукований вгорі малими літерами з першої прописної, симетрично щодо тексту сторінки. Посередині рядка над заголовком малими літерами з першої прописної повинно бути надруковано слово “Додаток ” і прописна буква, що позначає додаток. Додатки слід позначати послідовно прописними буквами українського алфавіту, за винятком букв Ґ, Є, З, І, Ї, Й, О, Ч, Ь. Один додаток позначається як А. Додатки повинні мати загальну з іншою частиною пояснювальної записки наскрізну нумерацію. Текст кожного додатка, при необхідності, може бути розділений на підрозділи і пункти, що нумеруються арабськими цифрами в межах кожного додатка.

 

ЛІТЕРАТУРА

1. Бадд Т. Объектно-ориентированное программирование в действии: Пер. с англ./Тимоти Бадд. – СПб.: Питер, 1997.– 464 с.

2. Бондарев В.М., Программирование на С++. Учебное пособие. – Харьков: СМИТ, 2004г. – 294 с.

3. Гамма Э. И др. Приемы объектно-ориентированного программирования. - СПб.:Питер, 2001г.

4. Дейтел Х., Дейтел П. Как программировать на С++. Третье издание.-М.:ЗАО „Издательство БИНОМ”, 2001г.-1152с.

5. Дьюхарт С. Старк К. Программирование на С++. Киев: Диалог Софт, 1993г.

6. Ирэ Пол. Объектно-ориентированное программирование с использованием C++: Пер. с англ. - Киев: НИИПФ ДиаСофт Лтд, 1995. 480с.

7. Павловская Т.А. С/С++. Программирование на языке высокого уровня.- СПб.: Питер, 2001.- 464 с.

8. Прата Стивен. Язык программирования С. Лекции и упражнения. Учебник.‑ СПб.: ООО «ДиаСофтЮП», 2002.‑ 896 с.

9. Скляров В.А. Язык C++ и объектно-ориентированное программирование: Справочное издание. - Минск: Вышэйшая школа, 1997. 480с.

10. Страуструп Б. Язык программирования С++. Специальное издание.-М., СПб.:”Издательство БИНОМ” – „Невский Диалект”, 2001г.-1099 с.

11. Сэвитч У. С++ в примерах.-М:Экон, 1997г.

12. Фридман А.Л. Основы объектно-ориентированной разработки программных систем. -М. Финансы и статистика. 2000г.

13. Черепанцев А.С. Введение в С и С++. Таганрог.

14. Шмак Н.К. Основы С++ и объектно-ориентированного программирования. Киев: Диалектика, 1996г.

ПЕРЕЛІК ПОСИЛАНЬ

1. Юркин А.Г. Задачник по программированию. – СПб.: Питер, 2002. – 192 с.

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

3. Методические указания по оформлению библиографических ссылок и списков к курсовым, дипломным и научным работам для студентов всех форм обучения и всех специальностей /Сост. Л.П. Гуданова, А.П.Мальцев, Л.П.Щербакова, А.К.Безуглая. - Харьков: ХИРЭ, 1986. - 36 с.

ДОДАТОК А

Зразок титульної сторінки курсової роботи

Міністерство освіти і науки, МОЛОДІ ТА СПОРТУ україни

Луганський національний університет

 

Інститут інформаційних технологій

Кафедра інформаційних технологій та систем

 

ПОЯСНЮВАЛЬНА ЗАПИСКА

 

до курсової роботи на тему

“Розробка програмного комплексу для автоматизації обліку

платежів абонентів кабельного телебачення”

Спеціальність 6.050103 «Програмна інженерія»

 

Група 2ПІ

Студент Іванов І.І.

Керівник проекту

 

Луганськ, 2011