4.8.8 Керівництво програміста
Обов’язковими компонентами керівництва програміста є анотація і зміст.
У розділі “Призначення і умови застосування програми” вказуються призначення і функції, що виконуються програмою. Подаються відомості про умови, необхідні для виконання програми, а саме:
об’єм оперативної пам’яті;
вимоги до складу і параметрів периферійних пристроїв;
вимоги до програмного забезпечення;
інші вимоги.
У розділі “Характеристика програми” наводяться описи основних характеристик та особливостей програми, часові характеристики, режими роботи, засоби контролю правильності виконання і самовідновлювання програми, т.і.
Описи процедур визову програми описуються у розділі “Звернення до програми”. Наводяться способи передачі управління і параметрів даних та інша необхідна інформація.
У розділі “Вхідні та вихідні дані” подаються описи організації вхідної та вихідної інформації, що використовується програмою, а також, при необхідності, її кодування.
Розділ “Повідомлення” містить тексти повідомлень, що подаються програмісту чи оператору під час виконання програми, описи їхнього змісту та дії, яких необхідно вжити за цими повідомленнями.
Ілюстрації, таблиці, графіки тощо подаються у розділі “Додатки”.
4.8.9 Керівництво оператора
Обов’язковими компонентами керівництва оператора є анотація і зміст.
У розділі “Призначення програми” подаються відомості про призначення програми та інформація, достатня для розуміння функцій програми та її експлуатації.
У розділі “Умови виконання програми” вказують умови, необхідні для виконання програми, а саме мінімальний і максимальний склад апаратних та програмних засобів, інші умови.
Розділ “Виконання програми” містить інформацію про послідовність дій оператора, що забезпечують завантаження, запуск, виконання і завершення програми. Наводяться описи функцій, формату і можливих варіантів команд, за допомогою яких оператор здійснює завантаження та керує виконанням програми, а також відповіді програми на ці команди.
У розділ “Повідомлення оператору” включають тексти повідомлень, що видаються в ході виконання програми, опис їхнього змісту і відповідні дії оператора. Вказуються дії оператора у випадку збою у виконанні програми, можливості повторного запуску програми та ін.
Зміст розділів керівництва оператора допускається ілюструвати пояснюючими прикладами, таблицями, схемами, графіками.
Матеріали, які недоцільно включати до складу розділів, подають у додатках.
Правила виконання схем алгоритмів, програм, даних і систем
Правила виконання схем, що використовуються для відображення різноманітних видів задач обробки даних і засобів їх вирішення, а також умовні позначення (символи) в схемах алгоритмів, програм, даних і систем встановлені ГОСТ 19.701–90 (ISO 5807–85). Вимоги стандарту не розповсюджуються на форму записів та позначень, які вміщуються всередині символів або поряд з ними і призначені для уточнення функцій, що ними виконуються.
Схеми алгоритмів, програм, даних і систем (далі – схеми) складаються з символів визначеного значення, короткого текстового пояснення і з’єднуючих ліній. Рівень деталізації схеми залежить від розміру і складності задачі обробки даних і повинен бути достатнім для розуміння в цілому різних частин та взаємозв’язків між ними.
Схемою називають графічне представлення визначення, аналізу чи метода рішення задачі, в якому використовуються символи для відображення операцій, даних, потоку, обладнання і т.п. За своїм призначенням виділяють наступні види схем:
схеми даних, які відображають шлях даних при вирішенні задач і визначають етапи обробки, а також носії даних, що використовуються;
схеми програм, які відображають послідовність операцій в програмі;
схеми роботи системи, які відображають управління операціями і потік даних в системі;
схеми взаємодії програм, що відображають шлях активації програм і взаємодії з відповідними даними;
схеми ресурсів системи, які відображають конфігурацію блоків даних і блоків обробки, необхідну для рішення задачі чи набору задач.
Символи, які використовуються в схемах, поділяють на
основні (використовуються у випадках, коли точний тип (вид) процесу чи носія даних невідомий або відсутня необхідність в описі фактичного носія даних);
специфічні (використовуються у випадках, коли відомий точний тип (вид) процесу чи носія даних або необхідно описати фактичний носій даних).
Перелік символів і їхні описи подані у додатку 2.
Символи призначені для графічної ідентифікації функції, яку він відображає, незалежно від тексту всередині цього символу. Символи в схемі повинні розташовуватися рівномірно. Слід дотримуватися помірної довжини з’єднань і мінімального числа довгих ліній. При відображенні символів не повинні змінюватися кути та інші параметри, які впливають на відповідну форму символу. Символи у схемі повинні мати, по можливості, один розмір. При зображенні символів перевагу слід віддавати горизонтальній орієнтації, хоча інші орієнтації допускаються. Текст всередині символу, необхідний для розуміння його функцій, записується зліва направо і зверху вниз незалежно від напрямку потоку. Якщо обсяг тексту перевищує розміри символу, слід використати символ коментарю.
Якщо в схемі використовується ідентифікатор символів, то його розташовують зліва над символом.
Приклад.
xxx…x
yyy…y
При використанні описів символів вони розташовуються справа над символом.
Приклад.
xxx…x
yyy…y
У схемах роботи системи текст, що використовується для посилання на документацію, для символів, які відображають способи виведення даних, розміщується справа над символом, а для символів, які відображають способи введення, справа під символом.
Приклад.
xxx…x xxx…x
zzz…z zzz…z
Потоки даних чи потоки управління в схемах показують лініями. Напрямок потоку зліва направо і зверху вниз вважається стандартним. У випадках, коли необхідно внести більшу ясність в схему або напрямок потоку відмінний від стандартного, на лініях використовують стрілки.
У схемах слід уникати перетину ліній. Лінії, що перетинаються, не мають логічного зв’язку між собою, тому зміна напрямку в точках перетину не допускається.
П
риклад.
Дві чи більше вхідні лінії можуть об’єднуватися в одну лінію, місце об’єднання в такому випадку повинне бути зміщене.
П
риклад.
Лінії в схемах повинні підходити до символу або зліва, або зверху, а виходити справа чи знизу. Лінії повинні бути спрямовані до центру символу.
При необхідності лінії слід розривати для запобігання надміру перетинів або занадто довгих ліній, а також у випадках, якщо схема складається з кількох листів. З’єднувач на початку розриву називається зовнішнім з’єднувачем, а в кінці розриву – внутрішнім з’єднувачем.
Якщо символ має кілька виходів, то їх слід показувати:
кількома лініями від даного символу до інших символів;
однією лінією від даного символу, яка потім розгалужується у відповідну кількість ліній.
П риклади.
Кожен вихід з символу повинен супроводжуватися відповідним значенням умови, щоб показати логічний шлях, який він представляє.
Приклади.
A
=B
A<B
A>B
1
2
3
4
5
З
амість
одного символу з відповідним текстом
можуть бути використані кілька символів
з перекриттям зображення, кожен з яких
містить текст опису (використання або
формування кількох носіїв даних чи
файлів, виготовлення декількох копій
друкованих звітів, т. і.). Якщо кілька
символів представляють впорядковану
множину, то це впорядкування повинно
повинне розташовуватися від переднього
(першого) до заднього (останнього).
Приклади.
Додаток 1
Черкаський державний університет ім. Б.Хмельницького
Факультет_______________________________________________________________
Спеціальність____________________________________________________________