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

1. 1. Загальні положення
2. 1.1.2. Скорочене найменування системи
3. 1.2. Підстави для проведення робіт
4. 1.3. Найменування організацій - Замовника і Розробника
5. 1.3.2. Розробник
6. 1.4 Цілі, призначення та область використання системи
7. 1.5. нормативні посилання
8. 1.6 Черговість створення системи
9. 2. Основні технічні рішення
10. 2.1.2. Функціональна структура системи
11. 2.2. Рішення по взаємозв'язкам АС з суміжними системами, забезпечення її сумісності
12. 2.3 Рішення по режимам функціонування, діагностування роботи системи
13. 2.4. Рішення по персоналу і режимам його роботи
14. 2.5 Відомості про забезпечення заданих в технічному завданні споживчих характеристик системи, що визначають...
15. 2.6. Склад функцій, комплексів задач реалізуються системою
16. 2.7. Склад і розміщення комплексів технічних засобів
17. 2.8. Рішення за складом інформації, обсягу, способам її організації, видам машинних носіїв, вхідних...
18. 2.8.2. Рішення по призначеному для користувача інтерфейсу
19. 2.9 Методи і засоби розробки
20. 3. Заходи з підготовки об'єкта автоматизації до введення системи в дію
21. 3.1 Заходи з підготовки інформаційної бази
22. 3.2 Заходи з підготовки персоналу
23. 3.3 Заходи з організації робочих місць
24. 3.4 Заходи щодо зміни об'єкта автоматизації
25. 3.5 Інші заходи

Нижче представлений приклад (зразок) проектного документа "Пояснювальна записка до ескізного проекту на створення автоматизованої системи", заснований на методичних вказівках РД 50-34.698-90 .

Даний документ формується IT-фахівцем на стадії ескізного проектування інформаційної системи.

Як приклад розробки інформаційної системи узятий проект впровадження інформаційно-аналітичної системи «Корпоративне сховище даних».

На сторінці нижче наведений зміст пояснювальної записки ескізного проекту відповідно до ГОСТ, всередині кожного з розділів коротко наведені вимоги до змісту і текст прикладу заповнення (виділено вертикальною лінією).

Розділи пояснювальної записки:

1. загальні положення
2. Основні технічні рішення
   • Рішення за структурою системи, підсистем, засобам і способам зв'язку для інформаційного обміну між компонентами системи
   • Рішення по взаємозв'язкам АС з суміжними системами, забезпечення її сумісності
   • Рішення по режимам функціонування, діагностування роботи системи
   • Рішення по персоналу і режимам його роботи
   • Відомості про забезпечення заданих в технічному завданні споживчих характеристик системи, що визначають її якість
   • Склад функцій, комплексів задач реалізуються системою
   • Склад і розміщення комплексів технічних засобів
   • Рішення за складом інформації, обсягу, способам її організації, видам машинних носіїв, вхідних і вихідних документів і повідомлень, послідовності обробки інформації та інших компонентів
   • Методи і засоби розробки
3. Заходи з підготовки об'єкта автоматизації до введення системи в дію

Пояснювальна записка до ескізного проекту на створення автоматизованої системи «Корпоративне сховище даних»

1. Загальні положення

1.1. Найменування системи

1.1.1. Повне найменування системи

Повне найменування - корпоративне сховище даних.

1.1.2. Скорочене найменування системи

Скорочене найменування - КХД, Система.

1.2. Підстави для проведення робіт

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

наприклад:
Робота виконується на підставі договору № ... від ..., укладеного між ...

1.3. Найменування організацій - Замовника і Розробника

1.3.1. Замовник

Замовник: ВАТ Замовник
Адреса фактична: м Москва ...
Телефон / Факс: +7 (495) 2222222

1.3.2. Розробник

Розробник: ЗАТ Розробник
Адреса фактична: м Москва ...
Телефон / Факс: +7 (495) 3333333

1.4 Цілі, призначення та область використання системи

Визначаються цілі (чого хоче досягти організація Замовника від впровадження системи); призначення (для яких користувачів призначена); області використання АІС (які види діяльності організації Замовника охоплює система).

Інформація для розділів "Найменування системи", "Підстави для проведення робіт", "Найменування організацій Замовника і Розробника", "Цілі, призначення та область використання системи" береться з однойменних розділів технічного завдання на створення корпоративного сховища даних.

1.5. нормативні посилання

При ескізному проектуванні використовувалися наступні нормативно-технічні документи:

наприклад:
1. Технічне завдання на створення інформаційної системи КХД
2. ГОСТ 34 -...
3. ...

1.6 Черговість створення системи

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

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

2. Основні технічні рішення

2.1. Рішення за структурою системи, підсистем, засобам і способам зв'язку для інформаційного обміну між компонентами системи

2.1.1 Логічна і компонентна архітектура системи

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

наприклад:
Перелік використовуваних для створення системи КХД програмних засобів наведено нижче:
- СУБД (назва, версія);
- ETL додаток (назва, версія);
- BI додаток (назва, версія).
Логічна і компонентна архітектура системи представлена ​​на малюнку нижче.

До складу системи, що розробляється будуть включені наступні технологічні компоненти:
- програмне забезпечення підтримки моделі даних;
- ETL-додаток - це комплексне рішення, за допомогою якого реалізуються процеси вилучення, перевірки, перетворення і завантаження даних.
- сервер БД являє собою промислову систему управління базами даних.
- сервер додатків - продукт, що забезпечує підтримку промислової інфраструктури бізнес-додатків. Включає в себе наступний ряд додатків, що забезпечують стандартні підходи до організації служб каталогів; розгортання сервісів аналізу і звітності.
- кошти адміністрування та розробки - набір програмних продуктів, призначених для адміністрування системи ETL, бази даних, сервера додатків і розробки звітності та додаткових додатків .
- клієнтські місця співробітників (всередині локальної обчислювальної мережі), що представляють собою автоматизовані робочі місця.

2.1.2. Функціональна структура системи

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

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

Потім проводиться опис взаємозв'язків між підсистемами. Опис взаємозв'язків формується шляхом відповіді на питання: «Який процес визначає взаємозв'язок між кожною з підсистем?».

наприклад:
Зв'язок «Підсистема збору, обробки і завантаження даних - Підсистема зберігання даних» визначає процес завантаження даних в ХД. Завантаження даних відбувається по протоколу <вказати протокол> в певні часові інтервали і з заданою періодичністю.

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

2.2. Рішення по взаємозв'язкам АС з суміжними системами, забезпечення її сумісності

Визначаються рішення по взаємозв'язкам системи КХД з суміжними системами, забезпечення її сумісності (опис використовуваних протоколів обміну даними і засоби і методи обміну даними). За основу беруться дані з пункту « Вимоги до характеристик взаємозв'язків із суміжними системами »Технічного завдання.

2.3 Рішення по режимам функціонування, діагностування роботи системи

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

наприклад:
Пропонується наступна реалізація рішень по режимам функціонування системи:
- Основний режим, в якому все підсистеми виконують свої основні функції.
- Профілактичний режим, в якому одна або всі підсистеми не виконують своїх функцій. В даний режим роботи система переходить в наступних випадках: виникнення необхідності модернізації апаратно-програмного комплексу; виникнення необхідності проведення технічного обслуговування; вихід з ладу апаратно-програмного комплексу, викликаний виходом з ладу елементів апаратної або програмної бази; вихід з ладу мережі передачі даних і інші аварійні ситуації.
В основному режимі функціонування система забезпечує:
- роботу користувачів в режимі - 24 години на добу, 7 днів на тиждень (24х7);
- виконання своїх функцій - збір, обробка та завантаження даних; зберігання даних, надання звітності за показниками.
У профілактичному режимі система забезпечує можливість проведення наступних робіт: - технічне обслуговування;
- модернізацію апаратно-програмного комплексу;
- усунення аварійних ситуацій.
Приймається попереднє рішення про те, що загальний час проведення профілактичних робіт не повинна перевищувати X% від загального часу роботи системи в основному режимі (XX годин в місяць).
Приймається попереднє рішення про те, що для забезпечення високої надійності функціонування як системи в цілому, так і її окремих компонентів необхідно проводити регулярне діагностування стану компонентів.
У таблиці нижче представлені засоби діагностики по підсистемах. Підсистема Засоби діагностування Підсистема збору, обробки і завантаження даних ETL Administrator - діагностика і настройка ETL-додатки, управління критеріями вилучення, установка NLS;
ETL Manager - перегляд і редагування сховища. Підсистема зберігання даних DB Manager - діагностика і настройка і конфігурація однієї або більше БД Підсистема відображення звітності BI Administrator - діагностика і настройка бізнес-опису та подання вітрин даних

Далі для кожної підсистеми наводяться приблизні сценарії проведення її діагностування. Щоб описати сценарії діагностування необхідно відповісти на наступні питання: «Ким проводиться діагностування?», «Яке програмне забезпечення використовується?», «Які дії (дії прописуються загальні, наприклад, зайти, відкрити, перевірити) необхідно провести для діагностування?», «Що необхідно перевірити? (Наприклад, наявність вільного місця на дисках) »,« Як часто необхідно виконувати дані дії? ». Необхідно також вказувати критичність підсистеми для функціонування системи в цілому.

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

2.4. Рішення по персоналу і режимам його роботи

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

Наприклад: Роль Підрозділ Кінцевий користувач Аналітичне управління Адміністратор підсистеми збору, обробки і завантаження даних Департамент інформаційних технологій Адміністратор підсистеми зберігання даних Департамент інформаційних технологій ... ...

2.5 Відомості про забезпечення заданих в технічному завданні споживчих характеристик системи, що визначають її якість

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

Наприклад: Вимога Метод реалізації Взаємодія з суміжними системами Реалізується за рахунок наявності інтерфейсів з системами - джерелами даних. Планується використання проміжних баз даних; інтеграція «точка - точка» (point-to-point); інтерактивна завантаження інформації з файлів певного формату. Діагностування системи Реалізується шляхом визначення переліку робіт з діагностування підсистем. Збереження працездатності системи в різних ймовірних умовах Реалізується шляхом розробки процедур резервного копіювання, підготовки персоналу, використання сучасних методів розробки і перевірених на практиці стандартних програмних засобів.
На об'єкті автоматизації обов'язково ведення журналів інцидентів в електронній формі, а також графіків і журналів проведення ППР відповідно до затверджених для кожного об'єкта ХД заходами з підтримки його працездатності. ... ...

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

Наприклад: Підсистема Функція Метод реалізації Підсистема збору, обробки і завантаження даних Управління процесами збору, обробки і завантаження даних Шляхом впровадження комплексного ETL-додатки Запуск процесів збору , Обробки і завантаження даних з джерел в ХД Шляхом розробки і впровадження регламентів запуску ETL-процесів ... ... Підсистема зберігання даних Створення і супровід структур бази даних Шляхом застосування CASE-засобу і засобів адміністрування СУБД Здійснення резервного копіювання даних Шляхом застосування наступних видів копіювання: повне холодну копіювання; логічне копіювання; инкрементальное копіювання ... ...

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

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

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

Підзадача Дія ... ...

В даній таблиці для кожного завдання наводиться перелік подзадач і сценарій їх виконання. Перелік подзадач формується таким чином: береться найменування завдання і з назви завдання виділяються підзадачі, наприклад завдання «Підтримка (розробка, модифікація) моделі ХД» містить в собі дві підзадачі «Розробка» і «Модифікація», завдання «Створення, редагування та видалення процесів збору , обробки і завантаження даних »містить в собі такі підзадачі:« Створення нового процесу »,« Редагування процесу »,« Видалення процесу »і т.п.

Далі для кожної віділеної підзадачі наводитися опис сценаріїв ее Виконання. Сценарій формується Шляхом послідовніх Відповідей на следующие питання:
Питання: «Хто віробляє дії для Виконання підзадачі?»
Відповідь: «Адміністратор підсістемі ...»
Питання: «Що повинен сделать Адміністратор? До которого ПС звернути? Який файл вібрато? »
Відповідь: «Адміністратор підсістемі звертається до програми ... і відкріває Ранее розроблення ...»
Питання: «Які дії после Відкриття в рамках підзадачі повинен Виконати Адміністратор?»
Відповідь. «Адміністратор підсістемі звертається до програми ... і відкріває Ранее розроблення ... Адміністратор вносити Зміни в ..., що містять ...»
Питання: «Які дії Виконує сама Підсистема в момент Дії Адміністратора? Чи з'являється діалогове вікно? »
Відповідь: «Адміністратор підсистеми звертається до програми ... і відкриває раніше розроблений .... Адміністратор вносить зміни в ..., що містять .... Підсистема запитує необхідність збереження роботи у вигляді робочого файлу ...»
Питання: «Які дії виконує Адміністратор після появи діалогового вікна?»
Відповідь: «Адміністратор підсистеми звертається до програми ... і відкриває раніше розроблений .... Адміністратор вносить зміни в ..., що містять .... Підсистема запитує необхідність збереження роботи у вигляді робочого файлу ... Адміністратор підтверджує команду збереження.» .

Наприклад, таблиця, яка містить опис сценаріїв для подзадач завдання "Створення, редагування та видалення процесів збору, обробки і завантаження даних", функції "Управління процесами збору, обробки і завантаження даних", підсистеми "Підсистема збору, обробки і завантаження даних" буде виглядати наступним чином.
2.6.1 Підсистема збору, обробки і завантаження даних
2.6.1.1 Функція «Управління процесами збору, обробки і завантаження даних»
Опис можливого сценарію для подальшої реалізації завдання «Створення, редагування та видалення процесів збору, обробки і завантаження даних» наведено в таблиці. Підзадача Дія Створення нового процесу - Адміністратор звертається до модуля розробки підсистеми на сервері розробки.
- Підсистема надає інструментальні засоби для створення нового процесу.
- Адміністратор підсистеми створює схему нового процесу ETL. На схемі вказуються компоненти процесу: джерела даних, компоненти перетворення даних, таблиці БД.
- Адміністратор підсистеми ініціює команду збереження створеного процесу.
- Підсистема розміщує створений процес на сервері середовища розробки.
- Адміністратор підсистеми виконує запуск, тестування і налагодження створюваного процесу. На вхід процесу подаються тестові дані. Аналізуючи підсумкові таблиці БД середовища розробки, Адміністратор приймає рішення про готовність нового процесу.
- Готовий процес переноситься на продуктивний сервер. Редагування процесу - Адміністратор підсистеми викликає підсистему середовища розробки на сервері розробки.
- Використовуючи інструментальні програмні засоби підсистеми, Адміністратор змінює схему процесу ETL, розміщує змінений процес на сервері середовища розробки.
- Підсистема розміщує редагований процес на сервері середовища розробки.
- Адміністратор підсистеми виконує запуск, тестування і налагодження редагованого процесу. На вхід процесу подаються тестові дані. Аналізуючи підсумкові таблиці БД середовища розробки, Адміністратор приймає рішення про готовність редагованого процесу.
- Готовий процес переноситься на продуктивний сервер. Видалення процесу - Адміністратор підсистеми викликає підсистему середовища розробки на сервері розробки.
- Використовуючи інструментальні програмні засоби підсистеми, Адміністратор видаляє процес ETL, розміщує зміни на сервері середовища розробки.
- Підсистема розміщує внесені зміни на сервері середовища розробки.
- Зміни переносяться на продуктивний сервер.

2.7. Склад і розміщення комплексів технічних засобів

Рішення по комплексу технічних засобів, його розміщення на об'єкті.

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

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

2.8.1 Опис інформаційної бази

У табличному вигляді наводиться перелік і опис предметних областей моделі даних сховища даних.

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

Нижче наводяться зображення відносин між сутностями всередині кожної предметної області. Дані зображення формуються на основі концептуальної моделі.

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

Наприклад: Сутність моделі даних Опис суті Договору на надання послуг (Billing Arrangement) Договору на надання послуг, укладені між Виконавцем і Замовником.
*** Приклад ***
Договір №15 від 31.05.2006
Договір №18 від 31.07.2007 Валюта (Currency) Валюта розрахунків.
*** Приклад ***
USD
EUR
RUR ... ...

2.8.2. Рішення по призначеному для користувача інтерфейсу

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

2.9 Методи і засоби розробки

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

Даний розділ формується на основі розділу « Вимоги до програмного забезпечення »Технічного завдання.
Уточнення даного розділу виробляються шляхом відповіді на наступні питання:
- «Які програмні засоби будуть використовуватися для реалізації системи?»
- «Які операційні системи будуть встановлені на серверах?»
- «Яка мова запитів буде використовуватися для роботи з БД? В якому стандарті? »
- «Які кошти будуть використовуватися для розробки призначених для користувача інтерфейсів і засобів генерації звітів (будь-яких твердих копій)?»
- «В рамках яких стандартів будуть проходить моделювання і опис? З використанням якого програмного забезпечення? »
- «Які засоби і методи розробки програмних засобів будуть використовуватися для реалізації системи?».

3. Заходи з підготовки об'єкта автоматизації до введення системи в дію

В даному розділі вказують:

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

Нижче представлений приклад вмісту даного розділу.

3.1 Заходи з підготовки інформаційної бази

Наводиться перелік заходів, які повинні бути проведені з метою приведення інформації до вигляду, придатного для використання системі КХД. Для цього необхідно відповісти на наступне питання: «Які технічні рішення необхідно узгодити між Розробником і Замовником?». Наприклад, формати взаємодії, способи взаємодії і т.п.

3.2 Заходи з підготовки персоналу

Розробляється перелік заходів, які необхідно провести Замовнику з метою підготовки користувачів і обслуговуючого персоналу системи КХД. Наприклад, комплектація штату, призначення відповідальних і т.п.

3.3 Заходи з організації робочих місць

Визначається перелік заходів, які повинні бути проведені Замовником з метою організації робочих місць розробників, користувачів, адміністраторів системи. Наприклад, організувати підмережа розробників і адміністраторів, організувати навчання і т.п. Також в цьому розділі наводяться попередні вимоги до робочих місць. Наприклад, вказується, що на робочих станціях користувачів повинен бути встановлений MS Internet Explorer не нижче версії 5.5 і т.п.

3.4 Заходи щодо зміни об'єкта автоматизації

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

3.5 Інші заходи

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