Основната цел на документа Обяснителна бележкае да предостави Главна информацияза системата и обосновката за технически решениявзети по време на неговото развитие. Следователно основата за разработването на Обяснителната бележка ще бъде основно Техническото задание.

Обяснителната бележка е един от най-важните документи на техническия проект. Техническият проект е разработен с цел идентифициране на крайните технически решения, които дават пълна картина на дизайна на продукта.
При разработване на програма за създаване на обяснителна бележка се препоръчва да се използва GOST 19.404-79 „Обяснителна бележка. Изисквания към съдържанието и дизайна.

За създаване на обяснителна бележка към техническия проект, описваща автоматизираната система (AS), се препоръчва използването на стандарта RD 50-34.698-90 „Автоматизирани системи. Изисквания към съдържанието на документите.

Много раздели от горните документи се припокриват, така че например ще разгледаме документа Обяснителна бележка, създаден на базата на RD 50-34.698-90

1 Общи положения

1.1 Име на проектирания AU

Този раздел от обяснителната бележка на документа съдържа пълното и краткото име на AU.

Например: „В този документ създаваната система се нарича Корпоративен информационен портал. Позволено е също така да се използва съкратеното име на инструмента или системата ".

1.2 Документи, въз основа на които се проектира системата

В този раздел на обяснителния документ трябва да се посочат препратки към договора и Техническо задание за разработване на автоматизирана система.

1.3 Организации, участващи в разработването на системата

В този раздел на обяснителната бележка са посочени имената на организациите на клиента и разработчиците.

1.4 Цели на развитието на АС

В този раздел на обяснителния документ трябва да бъдат посочени техническите, икономическите и производствените ползи, които клиентът ще получи след внедряването на разработваната система.

Например: „Целта на създаваната система е:

• оптимизиране на фирмения документооборот;
• поддържа Корпоративна културакомпании;
• оптимизиране на комуникациите между служителите на компанията. »

1.5 Предназначение и обхват на разработената AS

Този раздел на обяснителната бележка трябва да включва описание на вида дейност, която трябва да бъде автоматизирана, и списък на процесите, които системата е предназначена да автоматизира.

Например: „KIP е предназначен да предоставя пълна и актуална информация, както и ефективна организация на работата на служителите. Системата трябва да осигурява организация съвместна работаслужители чрез следните опции:

• Създаване на конференции за обсъждане на въпроси;
• Изпращане/Получаване на съобщения по електронна поща;
• Осигуряване на сътрудничество по документи;
• Съгласуване на документи;
• Водене на записи на входящи и изходящи документи.

1.6 Информация за регулаторните и технически документи, използвани при проектирането

Този раздел трябва да посочи стандартите, използвани при създаването на обяснителния документ.

Например: „При проектирането са използвани следните регулаторни и технически документи:

• ГОСТ 34.201-89 " Информационни технологии. Набор от стандарти за автоматизирани системи. Видове, пълнота и обозначения на документи при създаване автоматизирани системи»;
• GOST 34.602-89 „Информационни технологии. Набор от стандарти за автоматизирани системи. Техническо задание за създаване на автоматизирана система”;
• GOST 34.003-90 „Информационни технологии. Набор от стандарти за автоматизирани системи. Автоматизирани системи. Термини и определения“;
• GOST 34.601-90 „Информационни технологии. Набор от стандарти за автоматизирани системи. Автоматизирани системи. Етапи на създаване“;
• РД 50-682-89 " Насоки. Информационни технологии. Набор от стандарти и насоки за автоматизирани системи. Общи положения”;
• РД 50-680-88 „Указания. Автоматизирани системи. Основни разпоредби”;
• РД 50-34.698-90 „Указания. Информационни технологии. Набор от стандарти и насоки за автоматизирани системи. Автоматизирани системи. Изисквания за съдържанието на документа.

1.7. Редът на създаване на системата

За системи, създадени в няколко итерации, обяснителната бележка трябва да посочва обема на работа за всяка итерация. Отделно е необходимо да се подчертае работата, планирана за тази итерация.

Например: „Реализация на проекта на Корпор Информационен порталпланирано на два етапа.

Първата фаза на CIP включва организирането на съвместна работа на служителите на компанията благодарение на въвеждането на такива възможности като:

• Мигновени съобщения;
• Организация на конференцията;
• Предаване/приемане електронна поща;
• Съгласуване на документи чрез Системата.»

2 Описание на процеса на дейност

Този раздел на обяснителния документ трябва да отразява процесите и функциите, автоматизирани от системата в рамките на целия бизнес процес.

За илюстриране на материала в обяснителната бележка е позволено да се използват UML, ARIS или IDF0 нотации, както и схематични изображения, създадени с помощта на стандартни приложения (Visio).

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

Например: „1. Потребителят създава документ

• Потребителят инициира процеса на подаване на документ за одобрение
• Системата променя статуса на документа на „в процес на одобрение“. »
• Основни технически решения

2.1. Решения за структурата на системата и подсистемите.

Този раздел на Обяснителната бележка на документа предоставя решения относно функционалната структура на системата и нейните подсистеми.

2.2. Средства и методи на взаимодействие между компонентите на системата. Връзка с външни системи

В този раздел на документа Обяснителна бележка трябва да посочите списъка на системите, с които трябва да взаимодейства създаденият продукт. Когато се описва взаимодействието на компонентите на системата в Обяснителната бележка, е необходимо да се посочи форматът за обмен на данни.

Например: „Като част от взаимодействието на инструментите с външни системи се използват следните технологии:
- "Счетоводство на предприятието" - обмен на файлове в установения XML/Excel формат.

2.3. Решения по режими на работа

Този раздел на документа Обяснителна бележка включва списък и описание на режимите на работа на системата. Обикновено се разграничават следните режими: нормален режим, режим на тестова работа, сервизен режим. В обяснителната бележка е необходимо да се даде описание както на самия режим, така и на случаите, в които се въвежда.

2.4. Решения за броя, квалификацията и функциите на персонала на АЕЦ

Този раздел от обяснителната бележка регламентира дейностите на персонала по поддръжката и на функционалния персонал. В обяснителната бележка е необходимо да се посочи категорията служители, която се отнася към определен вид персонал и да се опишат функциите им в рамките на системата.

Например: „Администраторът на портала отговаря за:

• целостта на базата данни и софтуер;
• превантивни мерки за гарантиране на безопасността на данните;
• разпределение на правата за достъп и регистрация на потребители в системата. »

2.5. Осигуряване на подаденост техническо заданиепотребителските характеристики на системата

Този раздел от обяснителната бележка е създаден въз основа на изискванията за качество на продукта, посочени в техническите задания. Тук е необходимо да се опише параметърът, по който се определя качеството на системата. В обяснителната бележка са посочени и решенията, чрез които е постигната тази характеристика в системата.

Например: „Толерантност на грешки и работоспособност софтуерни модулиИнструментите се осигуряват чрез използването на индустриални софтуерни платформи IBM WebSphere Portal, Enterprise Oracle 10g.”

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

Този раздел на документа Обяснителна бележка съдържа списък със задачи, които системата решава. В обяснителната бележка функциите и наборът от задачи могат да бъдат представени като неномериран списък.

2.7. Решения за комплекса от технически средства, неговото поставяне в обекта

Този раздел на Обяснителната бележка на документа съдържа решения относно техническата архитектура на системата и изисквания за набора от технически средства, необходими за осигуряване на правилното й функциониране.

Изискванията към комплекса от технически средства в обяснителната бележка се препоръчват да бъдат поставени под формата на таблица.
Например: "

»

Когато описвате поставянето на обекти от комплекс от технически съоръжения в обяснителна бележка, е необходимо да се ръководите от изискванията на SNiP 11-2-80 за сгради от категория "B".

2.8. Обем, състав, методи на организация, последователност на обработка на информацията

Информационната поддръжка включва информационна поддръжка на машината и извън нея. Като вътрешен информационна поддръжкаса базата данни (БД), входните и изходните документи, идващи от външни системи.

Извънмашинната информационна база се формира от данните, съдържащи се в хартиените документи. Често при разработването на автоматизирани системи се използва само информационната база в машината, следователно основният акцент в Обяснителната бележка трябва да се постави върху съдържанието на този раздел.

При описанието на вградената в машината информационна базав документа Обяснителна бележка е необходимо да се посочат входните и изходните документи и съобщения за всички подсистеми и външни системи.

Например: „Входната информация за подсистемата електронно управление на документие:

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

Изходната информация за подсистемата за електронно управление на документи е:

• списание за история жизнен цикълдокумент;
• дневник на историята на одобрение на документи;
• файл електронна версиядокумент във формат RTF. »

2.9. Съединение софтуерни продукти, езици на дейност, алгоритми на процедури и операции и методи за тяхното изпълнение

В този раздел на Обяснителната бележка трябва да бъдат дадени технологии и инструменти за разработване на системата.

Например:
«

• Сървър за база данни: Oracle 10g
• Портал: Websphere Portal Extend v6.0.
• Бизнес моделиране: ARIS

»

3 Мерки за подготовка на обекта за автоматизация за пускане на системата в експлоатация

Този раздел на обяснителната бележка описва следните дейности:

• мерки за привеждане на информацията във форма, подходяща за обработка на компютър;
• мерки за обучение и проверка на квалификацията на персонала;
• мерки за създаване на необходимите звена и работни места;
• мерки за промяна на обекта на автоматизация;
• други дейности, идващи от специфични характеристикисъздаде AS

1. общи разпоредби;
2. описание на дейността;
3. основни технически решения;
4. дейности за.

[от точка 2.2.1 от РД 50-34.698-90]

Общи положения

В раздела "Общи разпоредби" те дават:

1. проектирани и наименованията на документите, техните номера и дата, въз основа на които се проектира АЕЦ;
2. списък на участниците в системата, срокове;
3. цели, предназначение и АС;
4. потвърждаване на съответствието на проектните решения с действащите стандарти и пожаро-взривна безопасност и др.;
5. информация за използваните в дизайна;
6. информация за, разширени, използвани при разработването на проекта;
7. реда на създаване на системата и обема на всяка.

[от точка 2.2.2 от РД 50-34.698-90]

Описание на процеса на дейност

В раздела „Описание на процеса на дейностите“ те отразяват състава на процедурите (), като се вземат предвид взаимосвързаността и съвместимостта на процесите и дейностите, формират организацията на работата в АС [от клауза 2.2.3 от РД 50 -34,698-90]

Основни технически решения

В раздела "Основни технически решения" те дават:

1. решения относно структурата на системата, средствата и методите за комуникация за обмен на информация между подсистемите;
2. решения за взаимното свързване на АС със съседни системи, осигуряващи го;
3. решения за работа на системата;
4. решения относно броя, квалификациите и функциите, режимите на работа, реда на взаимодействие;
5. информация за предоставянето на системата (подсистемите), посочени в характеристиките на потребителите, които я определят;
6. състав, комплекси от задачи (), реализирани от системата (подсистема);
7. решения за комплекса, поставянето му върху;
8. решения относно състава на информацията, обема, методите й, видовете компютър и документи, последователността и други компоненти;
9. решения относно състава, езиците на дейностите, процедурите и операциите и методите за тяхното изпълнение.

Разделът предоставя илюстрации на други документи, които могат да бъдат включени в съответствие с GOST 34.201 [от точка 2.2.4 от RD 50-34.698-90]

Мерки за подготовка на обекта за автоматизация за пускане на системата в експлоатация

В раздел "Мерки за подготовка за въвеждане в експлоатация на системата" водете:

1. мерки за привеждане на информацията във форма, подходяща за;
2. мерки за обучение и проверка на квалификацията на персонала;
3. мерки за създаване на необходимите звена и работни места;
4. мерки за промяна на обекта на автоматизация;
5. други дейности, базирани на специфичните характеристики на създадения AS.

GOST 19.404-79

Група T55

МЕЖДУДЪРЖАВЕН СТАНДАРТ

Единна система за програмна документация

ОБЯСНИТЕЛНА БЕЛЕЖКА

Изисквания към съдържанието и дизайна

Единна система за програмна документация. Обяснителна бележка. Изисквания към съдържанието и формата на представяне

Дата на въвеждане 1981-01-01

Указ на Държавния комитет на СССР по стандартите от 11 декември 1979 г. N 4753, като датата на въвеждане е определена на 01.01.81 г.

РЕПУБЛИКАЦИЯ. януари 2010 г


Този международен стандарт определя изисквания за съдържанието и представянето на политически документ"Обяснителна бележка", определена от GOST 19.101-77, която е част от документите на етапите на разработване на проекта и техническите проекти на програмата.

1. ОБЩИ РАЗПОРЕДБИ

1. ОБЩИ РАЗПОРЕДБИ

1.1. Структурата и дизайнът на документа са установени в съответствие с GOST 19.105-78.

Съставянето на информационната част (обобщение и съдържание) е по избор.

1.2. Обяснителната бележка трябва да съдържа следните раздели:

Въведение;

Предназначение и обхват;

спецификации;

очаквани технико-икономически показатели;

източници, използвани при разработката.

В зависимост от характеристиките на документа могат да се комбинират отделни раздели (подраздели), както и да се въвеждат нови раздели (подраздели).

2.1. В секцията „Въведение“ посочете името на програмата и (или) символтеми за разработка, както и документи, въз основа на които се извършва разработването, посочващи организацията и датата на одобрение.

2.2. В секцията "Цел и обхват" посочете целта на програмата, Кратко описаниеобхват на програмата.

2.3. Разделът "Спецификации" трябва да съдържа следните подраздели:

поставяне на задача за разработване на програма, описание на прилаганите математически методи и при необходимост описание на допусканията и ограниченията, свързани с избрания математически апарат;

описание на алгоритъма и (или) функционирането на програмата с обосновка за избор на схемата на алгоритъма за решаване на проблема, възможни взаимодействия на програмата с други програми;

описание и обосновка на избора на метод за организиране на входните и изходните данни;

описание и обосновка на избора на състава на хардуера и софтуера въз основа на изчисленията и (или) анализите, разпределението на носителите на данни, използвани от програмата.

2.4. В раздела "Очаквани технико-икономически показатели" се посочват технико-икономическите показатели, които обосновават предимството на избрания вариант на техническото решение, както и при необходимост очакваните експлоатационни показатели.

2.5. В раздела „Източници, използвани при разработката“ посочете списък с научни и технически публикации, нормативни документи и други научно-технически материали, които са посочени в основния текст.

2.6. Приложението към документа може да включва таблици, обосновки, методи, изчисления и други документи, използвани при разработката.



Електронен текст на документа
изготвен от ЗАО "Кодекс" и проверен спрямо:
официална публикация
Единна система от програмна документация:
сб. GOSTs. -
М.: Стандартинформ, 2010

от 01.01.74г

Този стандарт установява изисквания за изпълнение на технически проект за продукти във всички индустрии.

1. ОБЩИ РАЗПОРЕДБИ

2. ИЗИСКВАНИЯ ЗА ИЗПЪЛНЕНИЕ НА ДОКУМЕНТИ

ПРИЛОЖЕНИЕ

СПИСЪК НА ИЗВЪРШЕНИТЕ РАБОТИ ПРИ РАЗРАБОТВАНЕТО НА ТЕХНИЧЕСКИЯ ПРОЕКТ

В общия случай при разработването на технически проект се извършва следната работа: а) разработване на дизайнерски решения за продукта и неговите основни компоненти; б) извършване на необходимите изчисления, включително тези, потвърждаващи техническите и икономически показатели, установени от техническо задание;в) извършване на попълване на необходимите електрически схеми, схеми на свързване и др.; г) разработване и обосновка на технически решения, които осигуряват показатели за надеждност, установени от техническото задание и предишни етапи на разработка (ако тези етапи са били разработени); д) анализ на дизайна на продукта за технологичност, като се вземат предвид обратната връзка от производителите на промишлено производство по отношение на осигуряването на производственост в условията на това конкретно производство, включително използването на оборудване, налично в предприятието, както и отчитане на този проектизисквания на нормативната и техническата документация, която е в сила при производителя; идентифициране на ново оборудване, необходимо за производството на продукти (обосновка на разработка или придобиване); разработване на метрологично осигуряване (избор на методи и средства за измерване); е) производство и тестване на оформления на материалите и (или) разработване и анализ на електронни оформления”; ж) оценка на продукта във връзка с неговото съответствие с изискванията на икономиката, техническата естетика; з) оценка на възможността за транспортиране, съхранение и монтаж на продукта на мястото на неговата употреба; i) оценка на експлоатационните данни на продукта (взаимозаменяемост, лекота на поддръжка, поддръжка, устойчивост на влияния на околната среда, способност за бързо отстраняване на повреди, контрол на качеството на продукта, наличие на инструменти за контрол на техническото състояние и др.); j) финализиране на приложения за разработване и производство на нови продукти (включително измервателни уреди) и материали, използвани в разработвания продукт; k) предприемане на мерки за осигуряване на нивото на стандартизация и унификация на продукта, посочен в техническото задание; л) проверка на продукта за патентна чистота и конкурентоспособност, подаване на заявки за изобретения; м) идентифициране на асортимента от закупени продукти, координиране на използването на закупените продукти о) съгласуване на габаритни, монтажни и свързващи размери с клиента или основния потребител; о) оценка на техническото ниво и качеството на продукта; п) разработка на чертежи монтажни единиции части, ако това е причинено от необходимостта от ускоряване на издаването на задача за разработване на специализирано оборудване за тяхното производство; в) проверка на съответствието на взетите решения с изискванията за безопасност и промишлена санитария; r) изготвяне списък на работите, които трябва да бъдат извършени на етапа на разработка и работна документация, в допълнение и (или) изясняване на работата, предвидена в техническото задание, техническото предложение и проектопроекта; 4) . у) изготвяне на предложения за използване на софтуерно-информационно осигуряване на автоматизирани системи при разработване на работна проектна документация (Въведена допълнително, Изм. № 5).

По-долу е даден пример (извадка) на проектен документ " Обяснителна записка към техническия проект за създаване на автоматизирана система„въз основа на методически указания РД 50-34.698-90. Този документ се формира от ИТ специалист на етапа техническо проектиране на информационната система.

Като пример за разработване на информационна система е използван проектът за внедряване на информационно-аналитична система. "Корпоративен склад за данни".

На страницата по-долу е съдържание на обяснителната записка на техническия проектв съответствие с GOST, във всеки от разделите накратко са дадени изискванията към съдържанието и текста на примера за попълване(маркирано с вертикална линия).

Раздели от обяснителната бележка:

Общи положения

Основни технически решения

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

Решения за взаимно свързване на АС със съседни системи, осигуряващи неговата съвместимост

Решения за режими на работа, диагностика на работата на системата

Решения относно персонала и начините на неговата работа

Информация за осигуряване на потребителските характеристики на системата, посочени в техническото задание, които определят нейното качество

Съставът от функции, комплекси от задачи, изпълнявани от системата

Състав и разположение на комплекси от технически средства

У дома » Полезен » GOST обяснителна бележка технически проект. Обяснителна бележка към техническия проект. Взаимодействие със свързани системи