Методичні вказівки
по виконанню загальних розділів
курсових робіт і звітів по практиках,
які відповідають
Єдиній системі програмної документації
для студентів спеціальностей:
5.05010301 – Розробка програмного забезпечення
(5.080405 – Програмування для електронно-обчислювальної техніки і автоматизованих систем),
5.05010101 – Обслуговування програмних систем і комплексів
(5.080406 – Експлуатація систем обробки інформації та прийняття рішень)
Краматорськ
Методичні вказівки до виконання загальних розділів курсових робіт та звітів по практикам для студентів спеціальностей 5.05010301 – Розробка програмного забезпечення (5.080405 – Програмування для електронно-обчислювальної техніки і автоматизованих систем), 5.05010101 – Обслуговування програмних систем і комплексів (5.080406 – Експлуатація систем обробки інформації та прийняття рішень). Денне та заочне відділення. Включає зміст звіту по практиці, короткі пояснення по кожних пунктах, перелік літературі, що рекомендується / Укл. О.В. Олійник, М.О. Ахромов – Краматорськ: МК ДГМА, 2009. – 27 с.
Укладач О.В. Олійник, викладач вищої кваліфікаційної категорії
М.О. Ахромов, викладач категорії спеціаліст
Розглянуто на засіданні циклової комісії «Інформатика та обчислювальна техніка»,
Протокол від в 2009 р. №
Голова циклової комісії
О.В. Олійник
Зміст
1 Загальні вимоги по оформленню програмної документації 4
1.1 Загальні вимоги. 4
1.2 Нумерація сторінок. 5
1.3 Нумерація розділів, підрозділів, пунктів і підпунктів. 5
1.4 Ілюстрації 5
1.5 Таблиці 6
1.6 Посилання. 7
2 розділи курсових робіт та звітів з практики.. 8
2.1 Вимоги до змісту та оформлення розділу «Опис мови (середовища) програмування» 8
2.1.1 Зміст підрозділів. 8
2.2 Вимоги до змісту та оформлення розділу «Технічне завдання». 9
2.2.1 Зміст підрозділів. 9
2.3 Вимоги до змісту та оформлення розділу «Керівництво програміста». 12
2.3.1 Зміст підрозділів. 12
2.4 Вимоги до змісту та оформлення розділу «Керівництво користувача (оператора)» 13
2.3.1 Зміст підрозділів. 13
2.5 Вимоги до змісту та оформлення розділу «Текст програми». 14
3 Приклад виконання розділів курсових робіт і звітів з практик 15
3.1 Приклад виконання технічного завдання. 15
3.1 Приклад виконання керівництва програміста. 20
3.1 Приклад виконання керівництва оператора (користувача) 23
4 Перелік посилань. 27
Загальні вимоги по оформленню програмної документації
Згідно державного стандарту ДСТУ 1.5:2003 Національна стандартизація і стандарту ДСТУ 3008-95 Документація, а так само Єдиної системи програмної документації (ЄСПД) при оформленні звіту по практиці слід дотримуватися наступних вимог:
Загальні вимоги
Звіти та курсові роботи виконуються на листах формату А4 (210х297 мм).
Текст звіту (теоретична частина і хід виконання практичного завдання) повинні бути набраний на комп'ютері.
При оформленні звіту по практиці на сторінці повинне бути розташовано не більше 40 рядків шрифтом 14 пт з одинарним інтервалом.
Параметри сторінки: ліве, верхнє і нижнє поле не менше 20 мм, праве – не менше 10 мм
Структурні елементи «ЗМІСТ», «Введення», «ВИСНОВКИ», «ПЕРЕЛІК ПОСИЛАНЬ» не нумерують, а їх назви вважаються заголовками структурних елементів.
Розділи і підрозділи повинні мати заголовки. Пункти і підпункти можуть мати заголовки.
Заголовки структурних елементів документу і заголовки розділів слід розташовувати посередині рядка і друкувати прописними (великими) буквами без крапки в кінці, не підкреслюючи.
Заголовка підрозділів, пунктів і підпунктів документу починають з абзацного відступу і друкують рядковими (маленькими) буквами, окрім першої прописної, не підкреслюючи, без крапки в кінці.
Якщо заголовок складається з двох і більш пропозицій, їх розділяють крапкою.
Перенесення слів в заголовку розділу не допускається.
Якщо заголовок розташований на двох і більший рядках, продовження заголовка починають під першою буквою назви на попередньому рядку.
Відстань між заголовком і подальшим або попереднім текстом повинне бути при машинному способі виконання документа не менше ніж два рядки.
Відстань між підставами рядків заголовка приймають таким же, як в тексті.
Не допускається розміщувати назву розділу, підрозділу, пункту або підпункту в нижній частині сторінки, якщо після нього розташований тільки один рядок тексту.
Абзацний відступ повинен бути однаковим у всьому документі і складати не менше 1,27 см. Вирівнювання - по ширині
Шрифт – Times New Roman, розмір – 14, зображення – звичайний.
Нумерація сторінок
Сторінки документу слід нумерувати арабськими цифрами.
Номер сторінки розташовується в правому верхньому кутку сторінки без крапки в кінці.
Титульний лист включають в загальну нумерацію сторінок. Номер на титульному листі не проставляють.
Ілюстрації і таблиці, розміщені на окремих сторінках, включають в загальну нумерацію сторінок документу.
Нумерація розділів, підрозділів, пунктів і підпунктів
Розділи, підрозділи, пункти і підпункти документа слід нумерувати арабськими цифрами.
Розділи документу відображаються арабськими цифрами без крапки, наприклад 1, 2, 3 і т.д.
Підрозділи повинні мати порядкову нумерацію в межах кожного розділу. Номер підрозділу включає номер розділу і порядковий номер підрозділу, наприклад, 1.1,1.2 і т.д.;
Пункти повинні мати порядкову нумерацію в межах кожного розділу або підрозділу.
Номер пункту складається з номера розділу і порядкового номера пункту, або з номера розділу, порядкового номера підрозділу і порядкового номера пункту, розділеного крапками, наприклад 1.1, 1.2 або 1.1.1, 1.1.2 і т.д.
Якщо текст ділять тільки на пункти, їх необхідно нумерувати порядковими номерами.
Номер підпункту складається з номера розділу, порядкового номера підрозділу, порядкового номера пункту і порядкового номера підпункту, розділеного крапкою, наприклад, 1.1.1.1, 1.1.1.2, 1.1.1.3 і т.д.
Якщо розділ, не маючи підрозділів, ділиться на пункти і далі – на підпункти, номер підпункту складається з номера розділу, порядкового номера пункту і порядкового номера підпункту, розділеного крапкою, наприклад, 1.1.3, 1.2.1 і т.д.
Якщо розділ або підрозділ складається з одного пункту, або пункт складається з одного підпункту, його нумерують.
Ілюстрації
Ілюстрації (малюнки, схеми, діаграми) слід розміщувати безпосередньо після тексту, в якому вони згадуються вперше, або на наступній сторінці. На всі ілюстрації повинні бути посилання в документі, наприклад, «на малюнку 1» «(малюнок 1)».
Ілюстрації можуть мати назву, яку розміщують під ілюстрацією. Назву малюнка починають з першої прописної букви.
При необхідності під ілюстрацією поміщають пояснюючі дані.
Ілюстрація відображається словом «малюнок», яке разом з назвою ілюстрації розміщують після пояснюючих даних, наприклад, «Малюнок 1 – Схема розміщення».
Ілюстрації нумерують арабськими цифрами в межах всього документа. В додатках ілюстрації нумеруються в межах кожного додатку.
Таблиці
Цифровий матеріал, як правило, оформляють у вигляді таблиці, відповідно до малюнка 1.
Таблицю слід розташовувати безпосередньо після тексту, в якому вона згадується вперше, або на наступній сторінці. На кожну таблицю повинне бути посилання з позначенням її номера, наприклад, «...в таблиці 3.2.».
Таблиці слід нумерувати арабськими цифрами порядковою нумерацією в межах розділу. Номер таблиці складається з номера розділу і порядкового номера таблиці, розділеного крапкою, наприклад, Таблиця 2.1 – перша таблиця другого розділу.
Таблиця_____ – ____________________________
номер назва таблиці
 | ||||
| ||||
|
Боковик Графи (колонки)
Малюнок 1 – Приклад оформленні таблиці
Таблиця може мати назву, яка пишеться з першої прописної букви рядковими буквами. Якщо назва таблиці не поміщається на одному рядку, то продовження назви переносять на наступний рядок, розташовуючи текст під першою буквою назви таблиці.
Якщо в документі поміщена тільки одна таблиця, її нумерують відповідно вищевикладеним вимогам.
Між таблицею і попереднім і подальшим текстом слід витримувати інтервал не менше одного рядка.
Якщо частина таблиці перенесена на наступну або ту ж сторінку, назву приводять тільки над першою частиною таблиці, над іншими її частинами приводять тільки номер таблиці з таким написом:
«Продовження таблиці ______» – на тій же сторінці або на подальших сторінках
«Закінчення таблиці ______» – на останній станиці, де розташована таблиця.
Слова «Таблиця», «Продовження таблиці», «Закінчення таблиці» пишуть над верхнім лівим кутом таблиці.
Заголовки граф (колонок) і рядків таблиць пишуть з великої букви, а підзаголовки граф – з маленької, якщо вони складають одне ціле із заголовком.
Розділяти заголовки і підзаголовки боковика і граф діагональними лініями заборонено.
Посилання
Посилання в тексті документу на джерела позначають порядковим номером по переліку посилань, виділеним двома квадратними дужками, наприклад «у відповідності з [1,с.56]».
Посилатися можна на документ в цілому або на його розділи. При повторних посиланнях на розділ або додаток указують тільки номер. Посилатися на малюнки, таблиці і т.п. не допускаються.
