- •Методичні вказівки
- •5.05010301 – Розробка програмного забезпечення
- •5.05010101 – Обслуговування програмних систем і комплексів
- •1 Загальні вимоги по оформленню програмної документації
- •1.1 Загальні вимоги
- •1.2 Нумерація сторінок
- •1.3 Нумерація розділів, підрозділів, пунктів і підпунктів
- •1.4 Ілюстрації
- •1.5 Таблиці
- •1.6 Посилання
- •2 Розділи курсових робіт та звітів з практики
- •2.1 Вимоги до змісту та оформлення розділу «Опис мови (середовища) програмування»
- •2.1.1 Зміст підрозділів
- •2.2 Вимоги до змісту та оформлення розділу «Технічне завдання»
- •2.2.1 Зміст підрозділів
- •2.3 Вимоги до змісту та оформлення розділу «Керівництво програміста»
- •2.3.1 Зміст підрозділів
- •2.4 Вимоги до змісту та оформлення розділу «Керівництво користувача (оператора)»
- •2.3.1 Зміст підрозділів
- •2.5 Вимоги до змісту та оформлення розділу «Текст програми»
- •3 Приклад виконання розділів курсових робіт і звітів з практик
- •3.1 Приклад виконання технічного завдання
- •3.1 Приклад виконання керівництва програміста
- •3.1 Приклад виконання керівництва оператора (користувача)
- •4 Перелік посилань
1.6 Посилання
Посилання в тексті документу на джерела позначають порядковим номером по переліку посилань, виділеним двома квадратними дужками, наприклад «у відповідності з [1,с.56]».
Посилатися можна на документ в цілому або на його розділи. При повторних посиланнях на розділ або додаток указують тільки номер. Посилатися на малюнки, таблиці і т.п. не допускаються.
2 Розділи курсових робіт та звітів з практики
Обов’язковими розділами курсових робіт та звітів з практики повинні бути:
– опис мови (середовища) програмування;
– технічне завдання на виконання курсової роботи або звіту з практики;
– керівництво програміста;
– керівництво користувача (оператора);
– текст програми.
2.1 Вимоги до змісту та оформлення розділу «Опис мови (середовища) програмування»
Згідно ГОСТ 19.506-79 «Описание языка. Требования к содержанию и оформлению» розділ повинен містити наступні підрозділи:
– загальні відомості;
– елементи мови.
Допускається вводити розділи:
– способи структуризації програми;
– засоби обміну даними;
– вбудовані елементи;
– засоби відладки програми.
Залежно від особливостей мови допускається об'єднувати окремі розділи або вводити нові.
2.1.1 Зміст підрозділів
У підрозділі «Загальні відомості» повинні бути вказані призначення і опис загальних характеристик мови, його можливостей, основних областей застосування і інші відомості.
У підрозділі «Елементи мови» повинно бути вказано опис синтаксису і семантики базових і складових елементів мови.
У підрозділі «Способи структуризації програми» повинні бути вказані способи виклику процедур передачі управління і інші елементи структуризації програми.
У підрозділі «Засобу обміну даними» повинно бути приведено опис мовних засобів обміну даними (наприклад, засоби введення-висновку, внутрішнього обміну даними і т. п.).
У підрозділі «Вбудовані елементи» повинні бути приведені опис вбудованих в мову елементів (наприклад, функції, класи і т. п.) і правила їх використовування.
У підрозділі «Засобу відладки програми» повинен бути приведене опис засобів відладки програм, семантики цих засобів, що є в мові, дані рекомендації по їх застосуванню.
При необхідності зміст розділів повинен бути пояснене прикладами.
У додатки до опису мови можуть бути включені додаткові матеріали (формалізовані описи мовних засобів, ілюстрації, таблиці, графіки, форми бланків і т. п.).
2.2 Вимоги до змісту та оформлення розділу «Технічне завдання»
Згідно ГОСТ 19.201-79 «Техническое задание. Требования к содержанию и оформлению» розділ повинен містити наступні підрозділи:
– введення;
– підстави для розробки;
– призначення розробки;
– вимоги до програми або програмного виробу;
– вимоги до програмної документації;
– стадії і етапи розробки;
– порядок контролю і приймання.
Залежно від особливостей програми або програмного виробу допускається уточнювати зміст розділів, вводити нові розділи або об'єднувати окремі з них.
2.2.1 Зміст підрозділів
У підрозділі «Введення» указують найменування, коротку характеристику області застосування програми або програмного виробу і об'єкту, в якому використовують програму або програмний виріб.
У підрозділі «Підстави для розробки» повинні бути вказані:
– документ (документи), на підставі яких ведеться розробка;
У підрозділі «Призначення розробки» повинне бути вказане функціональне і експлуатаційне призначення програми або програмного виробу.
Підрозділ «Вимоги до програми або програмного виробу» повинен містити наступні пункти:
– вимоги до функціональних характеристик;
– вимоги до надійності;
– умови експлуатації;
– вимоги до складу і параметрів технічних засобів;
– вимоги до інформаційної і програмної сумісності.
В пункті «Вимоги до функціональних характеристик» повинні бути вказаний вимоги до складу виконуваних функцій, тимчасові характеристики і т.п.
В пункті «Вимоги до надійності» повинні бути вказаний вимоги до забезпечення надійного функціонування.
В пункті «Умови експлуатації» повинні бути вказаний умови експлуатації (температура навколишнього повітря, відносна вогкість і т.п. для вибраних типів носіїв даних), при яких повинні забезпечуватися задані характеристики, а також вид обслуговування, необхідна кількість і кваліфікація персоналу.
В пункті «Вимоги до складу і параметрів технічних засобів» указують необхідний склад технічних засобів з вказівкою їх основних технічних характеристик.
В пункті «Вимоги до інформаційної і програмної сумісності» повинні бути вказаний вимоги до інформаційним структурами методів рішення, мов програмування і програмних засобів, що використовуються програмою.
У підрозділі «Вимоги до програмної документації» повинен бути вказаний попередній склад програмної документації і, при необхідності, спеціальні вимоги до неї.
У підрозділі «Стадії і етапи розробки» встановлюють необхідні стадії розробки, етапи і зміст робіт (перелік програмних документів, які повинні бути розроблені, узгоджені і затверджені), а також, як правило, терміни розробки і визначають виконавців.
Згідно ГОСТ 19.102-77 «Стадии разработки» підрозділ «Стадії і етапи розробки» повинен відповідати слідкуючій формі
Таблиця 1 – Стадії і етапи розробки
Стадії розробки |
Етапи робіт |
Зміст робіт |
1 |
2 |
3 |
1. Технічне завдання |
Обґрунтування необхідності розробки програми |
Постановка задачі Збір початкових матеріалів Вибір і обґрунтування критеріїв ефективності і якості програми, що розробляється. Обґрунтування необхідності проведення науково-дослідних робіт. |
Науково-дослідні роботи |
Визначення структури вхідних і вихідних даних. Попередній вибір методів рішення задач. Обґрунтування доцільності застосування раніше розроблених програм. Визначення вимог до технічних засобів. Обґрунтування принципової можливості рішення поставленої задачі |
Продовження таблиці 1
1 |
2 |
3 |
|
Розробка і затвердження технічного завдання |
Визначення вимог до програми. Розробка техніко-економічного обґрунтування розробки програми. Визначення стадій, етапів і термінів розробки програми і документації на неї. Вибір мов програмування. Визначення необхідності проведення науково-дослідних робіт на подальших стадіях. Узгодження і затвердження технічного завдання. |
2. Ескізний проект |
Розробка ескізного проекту |
Попередня розробка структури вхідних і вихідних даних. Уточнення методів рішення задачі. Розробка загального опису алгоритму рішення задачі Розробка техніко-економічного обґрунтування. |
Затвердження ескізного проекту |
Розробка записки пояснення. Узгодження і затвердження ескізного проекту. |
|
3. Технічний проект |
Розробка технічного проекту |
Уточнення структури вхідних і вихідних даних. Розробка алгоритму рішення задачі. Визначення форми представлення вхідних і вихідних даних. Визначення семантики і синтаксису мови. Розробка структури програми. Остаточне визначення конфігурації технічних засобів. |
Затвердження технічного проекту |
Розробка плану заходів щодо розробки і Впровадження програм. Розробка записки пояснення. Узгодження і затвердження технічного проекту. |
|
4. Робочий проект |
Розробка програми |
Програмування і відладка програми. |
Розробка програмної документації |
Розробка програмних документів відповідно до вимог ЄСПД та ДСТУ. |
|
Випробування програми |
Розробка, узгодження і затвердження порядку і методики випробувань.
|
Закінчення таблиці 1
1 |
2 |
3 |
|
|
Проведення попередніх державних, міжвідомчих, приймально-здавальних і інших видів випробувань. Коректування програми і програмної документації за наслідками випробувань. |
5. Впровадження |
Підготовка і передача програми. |
Підготовка і передача програми і програмної документації для супроводу і (або) виготовлення. Оформлення і затвердження акту про передачу програми на супровід і (або) виготовлення. Передача програми до фонду алгоритмів і програм. |
В підрозділі «Порядок контролю і приймання» повинні бути вказаний види випробувань і загальні вимоги до приймання робіт.