Документація на розробку інформаційних систем

Види та комплектність документів на інформаційні системи визначає Державний стандарт — «Інформаційна технологія. Види, комплектність і позначки документів при створенні автоматизованих систем». До таких документів найчастіше належать звіти про обстеження, науково-дослідну роботу, технічне завдання, ескізний проект, технічний проект, робочий проект.

Звіти про обстеження, науково-дослідну роботу та ескізний проект складаються в довільній формі. Їх структура та зміст можуть бути погоджені між замовником та розробником систем. Зміст і структуру технічного завдання, технічного та робочого проектів визначають державні стандарти.

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

1. Загальні відомості.

2. Призначення та мета створення системи.

3. Характеристика об'єктів автоматизації.

4. Вимоги до системи.

5. Склад та зміст робіт зі створення систем.

6. Порядок контролю та приймання системи.

7. Вимоги до складу і змісту робіт з підготовки об'єкта автоматизації до вводу системи в дію.

8. Вимоги до документації.

9. Джерела розробки.

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

Розділ «Загальні відомості» ознайомлює з організацією-замовником, а також розробником, визначає джерела фінансування розробки, термін початку та закінчення робіт, порядок оформлення результатів проектних робіт.

Розділ «Характеристика об'єктів автоматизації» містить найважливіші відомості про об'єкт (або посилання на документи, де такі відомості можна знайти). Наприклад, інформує про наявність обчислювальної техніки, розміщення підрозділів, основні їх функції тощо.

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

У цьому розділі можуть бути підрозділи — вимоги до системи в цілому, до функцій системи, а також до видів забезпечення.

У розділі «Склад та зміст робіт зі створення системи» міститься перелік стадій та етапів її створення, зазначається термін початку та закінчення кожного етапу або стадії, перелічуються виконавці робіт. Цей розділ містить також перелік документів, які мають завершувати кожний етап проектних робіт.

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

1. Зведення інформації, яку дістає інформаційна система, до вигляду, придатного для обробки на ЕОМ.

2. Створення необхідних для функціонування інформаційної системи підрозділів.

3. Термін і порядок комплектування штатів та навчання персоналу. Розділ «Вимоги до документації» містить погоджений із замовником перелік документів, які мають розроблятися. Обумовлено, які документи можуть здаватися на машинних носіях замовником та розробником і видається наказ про створення інформаційної системи.

У розділі «Джерела розробки» перелічуються документи й інформаційні матеріали, що використовувались під час розробки технічного завдання, а також ті, які знадобляться під час створення інформаційної системи.

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

Головне призначення ескізного проекту — дати стислий попередній опис системи, яка має створюватися. При цьому основні положення ескізного проекту набувають подальшого розвитку в технічному і робочому проектах. Ескізний проект може містити такі відомості: перелік функцій, що їх реалізує інформаційна система, форми первинних та вихідних докуменгів, відеокадрів, структури інформаційних масивів або їх назви та головне призначення, найважливіші алгоритми (формули) розрахунків, місця розташування та кількість ЕОМ для впровадження системи, порядок створення та впровадження системи тощо.

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

Технічний проект може бути оформлений як один документ, а може складатися з окремих документів, найчастіше таких: «Опис постановки задачі», «Опис алгоритму», «Опис інформаційного забезпечення», «Опис програмного забезпечення», «Опис технічного забезпечення», «Опис організаційного забезпечення». Якщо технічний проект оформлявся як один документ, то перелічені документи можуть становити розділи технічного проекту.

Постановка задачі має містити таку інформацію:

1 Характеристику задачі. При її описі слід назвати призначення, техніко-економічну сутність задачі і обґрунтувати необхідність її розв'язування на ЕОМ; навести перелік об'єктів, при управлінні якими розв'язується задача; описати призначення і використання вихідної інформації; зазначити періодичність розв'язування і термін видачі вихідної інформації; перелічити умови, за яких припиняється автоматизоване розв'язування задачі (у разі потреби перелічити зв'язки даної задачі з іншими задачами);

описати розподіл дій між персоналом і технічними засобами при різних ситуаціях розв'язування задачі.

2. Вихідну інформацію. У розділі описується її призначення і використання, а далі наводиться перелік і опис вихідних повідомлень у вигляді пояснювального тексту або таблиці. Серед вихідних повідомлень можуть бути машинограми (віддруковані на ЕОМ документи), відеокадри (інформація, яка виведена на екран ЕОМ) та масиви на машинних носіях, які використовуються для подальшого розв'язування даної задачі або інших задач. Для кожного повідомлення зазначаються його повна назва, ідентифікатор (умовна позначка), форма подання, періодичність видачі, термін видачі та одержувачі інформації. Перелік і опис структурних одиниць вихідних повідомлень, які мають самостійне змістове значення, подається у вигляді пояснювального тексту При описі слід наводити повну назву структурної одиниці інформації (показника), ідентифікатор вихідного повідомлення, до складу якого входить відповідна структурна одиниця (показник), і вимоги до точності та надійності (при потребі) розрахунку показника

3. Вхідну інформацію У тексті описують її призначення і засоби здобування, а потім наводять перелік і опис вхідних повідомлень у вигляді пояснювального тексту або таблиці. Для кожного вхідного повідомлення зазначається назва та ідентифікатор, форма подання, термін і частота використання. Серед вхідних повідомлень можуть бути документи, які заповнені в різних підрозділах організації, масиви нормативно-довідкової інформації та масиви, сформовані на ЕОМ під час розв'язування інших задач. Перелік і опис структурних одиниць інформації вхідних повідомлень подається у вигляді пояснювального тексту із зазначенням повної назви структурної одиниці, вимоги до точності числового значення (при потребі), джерела інформації (документ, відеокадр, база даних і т.ін.) і його ідентифікатора.

У додатку до постановки задачі наводяться ескізи вихідних і вхідних документів, які оформлюються згідно з Державним стандартом — «Системи обліково-статистичної, первинної облікової, фінансової та іншої документації. Основні положення і формуляри-зразки».

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

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

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

3. Математичний опис. У підрозділі наводиться математична модель чи математичні формули обчислення основних показників, які формуються задачею, а також наводиться опис процесу, об'єктів, перелік зроблених припущень і оцінок відповідності розробленої моделі реальному процесу за різних умов роботи системи.

4. Алгоритм розв'язування. У цьому підрозділі наводиться опис логіки алгоритму і спосіб формування результатів з посиланням на послідовність етапів обчислень. Алгоритм подається у вигляді схеми згідно з вимогами Державного стандарту — «Схеми алгоритмів, програм, даних і систем». Схему при потребі доповнюють текстом.

Структура документа «Опис інформаційного забезпечення» має такі підрозділи:

• загальна характеристика інформаційного забезпечення (ІЗ);

• опис організації збору та передачі інформації на обробку;

• побудова системи класифікації та кодування;

• форми первинних документів, машинограм та відеокадрів;

• структура інформаційних масивів.

У підрозділі «Загальна характеристика ІЗ» наводяться основні принципи, які використовуватимуться при побудові ІЗ, нормативні документи, які визначають побудову ІЗ, необхідність використання СУБД або застосування локальних масивів. Якщо визначена потреба використати СУБД, то обґрунтовують вибір конкретної СУБД і наводять її основні характеристики.

У цьому самому підрозділі наводять загальну схему ІЗ і подають перелік конкретних елементів 13, які будуть використані при розв'язуванні задачі.

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

У підрозділі «Побудова системи класифікації та кодування» подають перелік класифікаторів, наводять за кожним з них методи класифікації та кодування, структуру та довжину коду. У додатках можуть бути подані фрагменти або приклади класифікаторів.

У підрозділі «Форми первинних документів, машинограм та відеокадрів» наводиться перелік форм та посилання на додатки, де наведені відповідні форми, або подаються самі форми у вигляді таблиць.

У підрозділі «Структура інформаційних масивів» за кожним масивом наводять таблиці з описом структури масиву. Таблиця має містити такі відомості: найменування масиву, позначення масиву, найменування носія інформації, обсяг масиву, довжина запису, метод організації масиву, ключі впорядкування масиву. За кожним атрибутом (реквізитом) масиву в таблиці наводять його найменування, умовне позначення у формулах, формат, діапазон змін, логічні та семантичні зв'язки з іншими масивами або атрибутами.

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

Логічні та семантичні зв'язки наводяться для ієрархічних, сіткових та реляційних СУБД або СУБД на основі інвертованих списків, де створюються спеціальні масиви чи існує особливий механізм поєднання файлів.

Опис організаційного забезпечення може включати низку схем, зокрема схему організаційної структури підрозділів (осіб) і її опис. а також схему технологічного процесу автоматизованого збору інформації та її обробки. Описуючи технологічний процес, можна наводити окремі схеми.

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

2 Технологічний процес обробки даних на ОЦ або на АРМ (описують склад й послідовність виконання операцій з прийому, контролю, обробки, видачі результатів обробки).

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

Схему технологічних процесів складають згідно з чинними стандартами. Тут наводять опис комплексу технічних засобів (КТЗ). Обґрунтовують вибір КТЗ і описують його характеристики.

Якщо для обробки інформації використовують мережі ЕОМ. то в цьому разі описується загальна характеристика мережі та її особливості, режими роботи конкретної ЕОМ у мережі.

Опис програмного забезпечення містить:

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

• схему взаємодії програм;

• схеми програм.

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

Робочий проект майже ніколи не оформляється як один документ. Він складається з різних документів, які мають використовуватися під час експлуатації системи. До складу робочого проекту, окрім паперових документів, належать тексти програм на машинних носіях інформації або так званий виконуваний модуль, який працює під керуванням операційної системи і дозволяє обробляти інформацію на ЕОМ.

До складу документів робочого проекту найчастіше належать:

» опис програм, які розроблені для розв'язування задачі (опис може бути складений окремо для кожної програми);

• інструкції щодо операцій технологічного процесу або керівництво користувача;

• класифікатори техніко-економічної інформації.

Опис програм оформлюють згідно Державного стандарту — «ЕСКД. Текст програми. Вимоги до змісту і оформлення». До опису додасться лістинг програми (роздрукований текст програми). У поясненні до лістингу подається коментар, який пояснює призначення та структуру основних частин програми.

Інструкції щодо окремих операцій складаються тоді, коли операції виконуються на різних робочих місцях спеціалістами різної кваліфікації. Керівництво користувача складається для автоматизованого робочого місця спеціаліста, який більшість своїх функцій виконує за допомогою ЕОМ. Для нього можуть бути розроблені й окремі інструкції щодо операцій, які не пов'язані з обробкою інформації на ЕОМ.

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

Керівництво користувача має містити такі підрозділи: вступ, призначення та умови використання, підготовка до роботи, опис операцій, аварійні ситуації, рекомендації щодо освоєння.

У вступі наводять основну характеристику АРМ та перелічують функції, які на ньому виконуються. При описанні умов функціонування дають технічну характеристику ЕОМ, яка необхідна для створення АРМ, та характеристику додаткових технічних пристроїв, посилаються на операційну систему та програмні засоби, які необхідні для роботи.

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

При описі операцій щодо кожної з них дають докладний опис правил виконання операції, зазначають її особливості, можливі наслідки та приклади вибору тих чи інших дій. Обов'язково зазначаються умови, за яких можливе виконання операції. Дуже часто перелік операцій подається згідно із пунктами «меню», які покладені в основу роботи програм Для користувача такий підхід до опису операцій не завжди прийнятний, бо він має добре орієнтуватися в ієрархії функцій та їх особливостях для того, щоб обрати послідовність операцій для виконання конкретних дій. Тому в цьому підрозділі, окрім традиційного опису операцій, можуть наводитись описи операцій у такому вигляді: «Як виконати конкретні дії». Наприклад, користувач має сформувати машинний носій на основі первинних документів. Для цього в ієрархії «меню» є кілька режимів — створення та ведення НД1, введення оперативної інформації та коригування оперативної інформації. Для того щоб обрати правильну послідовність операцій, користувач має не лише добре знати призначення кожного режиму, а й уявити, як документ заноситься на носій інформації та навіщо застосовується НДІ. Для полегшення роботи користувача можна передбачити пункт у інструкції такого типу — як сформувати машинний носій інформації.

Підрозділ «Аварійні ситуації» має містити приклади аварійних ситуацій та дати поради, як поновити робот оздатність системи з мінімальними витратами часу та праці.

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

Класифікатори це окремі документи, де для кожного класифікатора наводиться його структура та подається повний перелік назв із відповідними їм кодами. Під час експлуатації інформаційної системи до класифікаторів можуть вноситися доповнення.