Обов’язковими розділами курсових робіт та звітів з практики повинні бути:
– опис мови (середовища) програмування;
– технічне завдання на виконання курсової роботи або звіту з практики;
– керівництво програміста;
– керівництво користувача (оператора);
– текст програми.
2.1 Вимоги до змісту та оформлення розділу «Опис мови (середовища) програмування»
Згідно ГОСТ 19.506-79 «Описание языка. Требования к содержанию и оформлению» розділ повинен містити наступні підрозділи:
– загальні відомості;
– елементи мови.
Допускається вводити розділи:
– способи структуризації програми;
– засоби обміну даними;
– вбудовані елементи;
– засоби налагодження програми.
Залежно від особливостей мови допускається об'єднувати окремі розділи або вводити нові.
Зміст підрозділів
У підрозділі «Загальні відомості» повинні бути вказані призначення і опис загальних характеристик мови, його можливостей, основних областей застосування і інші відомості.
У підрозділі «Елементи мови» повинно бути вказано опис синтаксису і семантики базових і складових елементів мови.
У підрозділі «Способи структуризації програми» повинні бути вказані способи виклику процедур передачі управління і інші елементи структуризації програми.
У підрозділі «Засобу обміну даними» повинно бути приведено опис мовних засобів обміну даними (наприклад, засоби введення-висновку, внутрішнього обміну даними і т. п.).
У підрозділі «Вбудовані елементи» повинні бути приведені опис вбудованих в мову елементів (наприклад, функції, класи і т. п.) і правила їх використовування.
У підрозділі «Засобу налагодження програми» повинен бути приведене опис засобів налагодження програм, семантики цих засобів, що є в мові, дані рекомендації по їх застосуванню.
При необхідності зміст розділів повинен бути пояснене прикладами.
У додатки до опису мови можуть бути включені додаткові матеріали (формалізовані описи мовних засобів, ілюстрації, таблиці, графіки, форми бланків і т. п.).
2.2 Вимоги до змісту та оформлення розділу «Технічне завдання»
Згідно ГОСТ 19.201-79 «Техническое задание. Требования к содержанию и оформлению» розділ повинен містити наступні підрозділи:
– введення;
– підстави для розробки;
– призначення розробки;
– вимоги до програми або програмного виробу;
– вимоги до програмної документації;
– стадії і етапи розробки;
– порядок контролю і приймання.
Залежно від особливостей програми або програмного виробу допускається уточнювати зміст розділів, вводити нові розділи або об'єднувати окремі з них.
Зміст підрозділів
У підрозділі «Введення» указують найменування, коротку характеристику області застосування програми або програмного виробу і об'єкту, в якому використовують програму або програмний виріб.
У підрозділі «Підстави для розробки» повинні бути вказані:
– документ (документи), на підставі яких ведеться розробка;
У підрозділі «Призначення розробки» повинне бути вказане функціональне і експлуатаційне призначення програми або програмного виробу.
Підрозділ «Вимоги до програми або програмного виробу» повинен містити наступні пункти:
– вимоги до функціональних характеристик;
– вимоги до надійності;
– умови експлуатації;
– вимоги до складу і параметрів технічних засобів;
– вимоги до інформаційної і програмної сумісності.
В пункті «Вимоги до функціональних характеристик» повинні бути вказаний вимоги до складу виконуваних функцій, тимчасові характеристики і т.п.
В пункті «Вимоги до надійності» повинні бути вказаний вимоги до забезпечення надійного функціонування.
В пункті «Умови експлуатації» повинні бути вказаний умови експлуатації (температура навколишнього повітря, відносна вогкість і т.п. для вибраних типів носіїв даних), при яких повинні забезпечуватися задані характеристики, а також вид обслуговування, необхідна кількість і кваліфікація персоналу.
В пункті «Вимоги до складу і параметрів технічних засобів» указують необхідний склад технічних засобів з вказівкою їх основних технічних характеристик.
В пункті «Вимоги до інформаційної і програмної сумісності» повинні бути вказаний вимоги до інформаційним структурами методів рішення, мов програмування і програмних засобів, що використовуються програмою.
У підрозділі «Вимоги до програмної документації» повинен бути вказаний попередній склад програмної документації і, при необхідності, спеціальні вимоги до неї.
У підрозділі «Стадії і етапи розробки» встановлюють необхідні стадії розробки, етапи і зміст робіт (перелік програмних документів, які повинні бути розроблені, узгоджені і затверджені), а також, як правило, терміни розробки і визначають виконавців.
Згідно ГОСТ 19.102-77 «Стадии разработки» підрозділ «Стадії і етапи розробки» повинен відповідати слідкуючій формі
Таблиця 1 – Стадії і етапи розробки
| Стадії розробки | Етапи робіт | Зміст робіт |
| 1. Технічне завдання | Обґрунтування необхідності розробки програми | Постановка задачі Збір початкових матеріалів Вибір і обґрунтування критеріїв ефективності і якості програми, що розробляється. Обґрунтування необхідності проведення науково-дослідних робіт. |
| Науково-дослідні роботи | Визначення структури вхідних і вихідних даних. Попередній вибір методів рішення задач. Обґрунтування доцільності застосування раніше розроблених програм. Визначення вимог до технічних засобів. Обґрунтування принципової можливості рішення поставленої задачі |
Продовження таблиці 1
| Розробка і затвердження технічного завдання | Визначення вимог до програми. Розробка техніко-економічного обґрунтування розробки програми. Визначення стадій, етапів і термінів розробки програми і документації на неї. Вибір мов програмування. Визначення необхідності проведення науково-дослідних робіт на подальших стадіях. Узгодження і затвердження технічного завдання. | |
| 2. Ескізний проект | Розробка ескізного проекту | Попередня розробка структури вхідних і вихідних даних. Уточнення методів рішення задачі. Розробка загального опису алгоритму рішення задачі Розробка техніко-економічного обґрунтування. |
| Затвердження ескізного проекту | Розробка записки пояснення. Узгодження і затвердження ескізного проекту. | |
| 3. Технічний проект | Розробка технічного проекту | Уточнення структури вхідних і вихідних даних. Розробка алгоритму рішення задачі. Визначення форми представлення вхідних і вихідних даних. Визначення семантики і синтаксису мови. Розробка структури програми. Остаточне визначення конфігурації технічних засобів. |
| Затвердження технічного проекту | Розробка плану заходів щодо розробки і Впровадження програм. Розробка записки пояснення. Узгодження і затвердження технічного проекту. | |
| 4. Робочий проект | Розробка програми | Програмування і відладка програми. |
| Розробка програмної документації | Розробка програмних документів відповідно до вимог ЄСПД та ДСТУ. | |
| Випробування програми | Розробка, узгодження і затвердження порядку і методики випробувань. |
Закінчення таблиці 1
| Проведення попередніх державних, міжвідомчих, приймально-здавальних і інших видів випробувань. Коректування програми і програмної документації за наслідками випробувань. | ||
| 5. Впровадження | Підготовка і передача програми. | Підготовка і передача програми і програмної документації для супроводу і (або) виготовлення. Оформлення і затвердження акту про передачу програми на супровід і (або) виготовлення. Передача програми до фонду алгоритмів і програм. |
В підрозділі «Порядок контролю і приймання» повинні бути вказаний види випробувань і загальні вимоги до приймання робіт.
2.3 Вимоги до змісту та оформлення розділу «Керівництво програміста»
Згідно ГОСТ 19.504-79 «Руководство программиста. Требования к содержанию и оформлению» розділ повинен містити наступні підрозділи:
– призначення і умови застосування програм;
– характеристика програми;
– звернення до програми;
– вхідні і вихідні дані.
Зміст підрозділів
У підрозділі «Призначення і умови застосування програм» повинні бути вказані призначення і функції, виконувані програмою, умови, необхідні для виконання програми (об'єм оперативної пам'яті, вимоги до складу і параметрів периферійних пристроїв, вимоги до програмного забезпеченню і т.п.).
У підрозділі «Характеристика програми» повинно бути приведено опис основних характеристик і особливостей програми (тимчасові характеристики, режим роботи, засоби контролю правильності виконання і т.п.).
У підрозділі «Звернення до програми» повинне бути приведене опис процедур виклику програми (способи передачі управління і параметрів даних і ін.).
У підрозділі «Вхідні і вихідні дані» повинно бути приведено опис організації використовуваної вхідної і вихідної інформації і, при необхідності, її кодування.
2.4 Вимоги до змісту та оформлення розділу «Керівництво користувача (оператора)»
Згідно ГОСТ 19.505-79 «Руководство оператора. Требования к содержанию и оформлению» розділ повинен містити наступні підрозділи:
– призначення програми;
– умови виконання програми;
– виконання програми;
– повідомлення оператору.
Зміст підрозділів
У підрозділі «Призначення програми» повинні бути вказані відомості про призначення програми і інформація, достатня для розуміння функцій програми і її експлуатації.
У підрозділі «Умови виконання програми» повинні бути вказані умови, необхідні для виконання програми (мінімальний і (або) максимальний склад апаратурних і програмних засобів і т.п.).
У підрозділі «Виконання програми» повинна бути вказана послідовність дій оператора, забезпечуючи завантаження, запуск, виконання і завершення програми, приведений опис функцій, формату і можливих варіантів команд, за допомогою яких оператор здійснює завантаження і управляє виконанням програми, а також відповіді програми на ці команди.
У підрозділі «Повідомлення оператору» повинні бути приведені тексти повідомлень, видаваних в ході виконання програми, опис їх змісту і відповідні дії оператора (дії оператора у разі збою, можливості повторного запуску програми і т.п.).
Допускається зміст підрозділів ілюструвати пояснюючими прикладами, таблицями, схемами, графіками.
2.5 Вимоги до змісту та оформлення розділу «Текст програми»
Згідно ГОСТ 19.401-78 «Текст программы. Требования к содержанию и оформлению» розділ повинен містити символічний запис на вихідній мові.
У символічний запис розділу рекомендується включати коментарі, які можуть відображати, наприклад, функціональне призначення, структуру
