Poniżej znajduje się przykład (przykład) dokumentu projektowego „ Nota wyjaśniająca do projekt techniczny stworzyć zautomatyzowany system", w oparciu o wytyczne RD 50-34.698-90. Dokument ten generowany jest na etapie przez informatyka projekt techniczny System informacyjny .
Jako przykład opracowania systemu informacyjnego posłużono się projektem wprowadzenia systemu informacyjno-analitycznego „Hurtownia danych korporacyjnych”.
Pokazuje to strona poniżej treść noty wyjaśniającej projektu technicznego zgodnie z GOST, w skrócie w każdej sekcji Podano wymagania dotyczące treści i tekst przykładowego wypełnienia.(wyróżnione pionową linią).
Sekcje noty wyjaśniającej:
Postanowienia ogólne
Główne rozwiązania techniczne
- optymalizacja obiegu dokumentów w firmie;
- wsparcie Kultura korporacyjna firmy;
- optymalizacja komunikacji pomiędzy pracownikami firmy. »
- Tworzenie konferencji w celu omówienia zagadnień;
- Wysyłanie/odbieranie wiadomości poczty elektronicznej;
- Zapewnienie współpracy nad dokumentami;
- Koordynacja dokumentów;
- Prowadzenie ewidencji dokumentacji przychodzącej i wychodzącej.”
- GOST 34.201-89 " Technologia informacyjna. Zbiór standardów dla systemów zautomatyzowanych. Rodzaje, kompletność i oznaczenia dokumentów przy tworzeniu zautomatyzowanych systemów”;
- GOST 34.602-89 „Technologia informacyjna. Zbiór standardów dla systemów zautomatyzowanych. Specyfikacje techniczne dotyczące utworzenia zautomatyzowanego systemu”;
- GOST 34.003-90 „Technologia informacyjna. Zbiór standardów dla systemów zautomatyzowanych. Zautomatyzowane systemy. Warunki i definicje";
- GOST 34.601-90 „Technologia informacyjna. Zbiór standardów dla systemów zautomatyzowanych. Zautomatyzowane systemy. Etapy tworzenia”;
- RD 50-682-89" Wytyczne. Technologia informacyjna. Zbiór standardów i wytycznych dla systemów zautomatyzowanych. Postanowienia ogólne";
- RD 50-680-88 „Instrukcje metodyczne. Zautomatyzowane systemy. Przepisy podstawowe”;
- RD 50-34.698-90 „Instrukcje metodyczne. Technologia informacyjna. Zbiór standardów i wytycznych dla systemów zautomatyzowanych. Zautomatyzowane systemy. Wymagania dotyczące treści dokumentów.”
- Wiadomości błyskawiczne;
- Organizacja konferencji;
- Transmisja/odbiór E-mail;
- Koordynacja dokumentów z wykorzystaniem Systemu.”
- Użytkownik inicjuje proces przekazania dokumentu do zatwierdzenia
- System zmienia status dokumentu na „do zatwierdzenia”. »
- Główne rozwiązania techniczne
- integralność bazy danych i oprogramowanie;
- środki zapobiegawcze zapewniające bezpieczeństwo danych;
- podział praw dostępu i rejestracja użytkowników w systemie. »
- elektroniczne wersje dokumentów przepływu pracy na produkcji;
- elektroniczny podpis cyfrowy;
- magazyn historyczny koło życia dokument;
- dziennik historii zatwierdzania dokumentów;
- plik elektronicznej wersji dokumentu w formacie RTF. »
- Serwer bazy danych: Oracle 10g
- Portal: Websphere Portal Extend v6.0.
- Modelowanie biznesowe: ARIS
- środki służące doprowadzeniu informacji do postaci odpowiedniej do przetwarzania komputerowego;
- działalność szkoleniowa i sprawdzająca kwalifikacje personelu;
- środki mające na celu utworzenie niezbędnych jednostek i miejsc pracy;
- środki mające na celu zmianę obiektu automatyzacji;
- inne działania w oparciu o specyfikę tworzonych systemów
Decyzje dotyczące struktury systemu, podsystemów, środków i sposobów komunikacji w celu wymiany informacji pomiędzy elementami systemu
Rozwiązania umożliwiające połączenie systemu głośnikowego z powiązanymi systemami i zapewnienie jego kompatybilności
Decyzje o trybach pracy, diagnozowanie pracy systemu
Decyzje dotyczące personelu i sposobów jego pracy
Informacje dotyczące zapewnienia właściwości konsumenckich systemu określonych w specyfikacjach technicznych, które decydują o jego jakości
Skład funkcji, zbiorów zadań realizowanych przez system
Skład i rozmieszczenie zespołów urządzeń technicznych
Głównym celem dokumentu Noty wyjaśniającej jest zapewnienie informacje ogólne o systemie i uzasadnieniu decyzji technicznych podejmowanych w procesie jego rozwoju. Dlatego podstawą opracowania Noty Wyjaśniającej będzie przede wszystkim SIWZ.
Nota wyjaśniająca jest jednym z najważniejszych dokumentów projektu technicznego. Projekt techniczny opracowywany jest w celu zidentyfikowania ostatecznych rozwiązań technicznych dających pełny obraz projektu produktu.
Opracowując program do tworzenia noty wyjaśniającej, zaleca się stosowanie GOST 19.404-79 „Nota wyjaśniająca. Wymagania dotyczące treści i projektu.”
Aby utworzyć notę wyjaśniającą do projektu technicznego opisującego system zautomatyzowany (AS), zaleca się skorzystanie z normy RD 50-34.698-90 „Systemy zautomatyzowane. Wymagania dotyczące treści dokumentów”.
Wiele sekcji powyższych dokumentów pokrywa się, dlatego jako przykład rozważymy dokument Nota wyjaśniająca stworzona na podstawie RD 50-34.698-90
1.1 Nazwa projektowanego głośnika
Ta sekcja dokumentu Noty wyjaśniającej zawiera pełną i skróconą nazwę systemu zewnętrznego.
Na przykład: „W tym dokumencie tworzony system nazywa się Portal Informacji Korporacyjnej. Dopuszczalne jest także używanie nazwy skróconej „KIP” lub „System”.
1.2 Dokumenty na podstawie których projektowany jest system
Ta sekcja dokumentu Noty wyjaśniającej powinna zawierać odniesienia do umowy i zakresu zadań i obowiązków dotyczących opracowania zautomatyzowanego systemu.
1.3 Organizacje zaangażowane w rozwój systemu
W tej sekcji dokumentu Noty wyjaśniającej podano nazwy organizacji klientów i programistów.
1.4 Cele rozwoju AS
W tej części dokumentu Noty Wyjaśniającej należy wskazać korzyści techniczne, ekonomiczne i produkcyjne, jakie uzyska klient po wdrożeniu opracowanego systemu.
Na przykład: „Celem tworzonego systemu jest:
1.5 Cel i zakres zastosowania opracowanego systemu głośnikowego
Ta część dokumentu Noty Wyjaśniającej musi zawierać opis rodzaju czynności podlegającej automatyzacji oraz listę procesów, które system ma automatyzować.
Przykładowo: „KIP ma na celu dostarczanie pełnej i aktualnej informacji oraz efektywną organizację pracy pracowników. System powinien zapewniać organizację wspólnej pracy pracowników wykorzystując następujące możliwości:
1.6 Informacje o dokumentach regulacyjnych i technicznych zastosowanych w projekcie
W tej sekcji należy wskazać standardy, które zostały wykorzystane przy tworzeniu dokumentu Noty Wyjaśniającej.
Na przykład: „Podczas projektowania wykorzystano następujące dokumenty regulacyjne i techniczne:
1.7. Sekwencja tworzenia systemu
W przypadku systemów tworzonych w kilku iteracjach Nota Wyjaśniająca powinna wskazywać zakres prac dla każdej iteracji. Osobno należy podkreślić prace zaplanowane w tej iteracji.
Przykładowo: „Wdrożenie projektu Portalu Informacji Korporacyjnej planowane jest w dwóch etapach.
Pierwszy etap oprzyrządowania obejmuje organizację wspólnej pracy pracowników firmy dzięki wprowadzeniu takich możliwości jak:
2 Opis procesu działania
Ta część dokumentu Noty wyjaśniającej powinna odzwierciedlać procesy i funkcje zautomatyzowane przez system w całym procesie biznesowym.
Do zilustrowania materiału w objaśnieniach dopuszcza się stosowanie notacji UML, ARIS lub IDF0, a także schematycznych obrazów utworzonych przy użyciu standardowych aplikacji (Visio).
Aby zrozumieć związek pomiędzy funkcjami zautomatyzowanymi i niezautomatyzowanymi w dokumencie Noty wyjaśniającej, konieczne jest wyraźne rozróżnienie pomiędzy działaniami użytkownika i działaniami systemu.
Na przykład: „1. Użytkownik tworzy dokument
2.1. Decyzje dotyczące struktury systemu i podsystemów.
W tej części dokumentu Nota wyjaśniająca przedstawia rozwiązania dotyczące struktury funkcjonalnej systemu i jego podsystemów.
2.2. Środki i metody współdziałania pomiędzy elementami systemu. Wzajemne połączenie z systemami zewnętrznymi
W tej części dokumentu Noty wyjaśniającej konieczne jest wskazanie listy systemów, z którymi musi współpracować tworzony produkt. Opisując współdziałanie elementów systemu w Nocie Wyjaśniającej, konieczne jest wskazanie formatu wymiany danych.
Przykładowo: „W ramach współdziałania oprzyrządowania i systemów zewnętrznych stosowane są następujące technologie:
- „Księgowość przedsiębiorstwa” – wymiana plików w ustalonym formacie XML/Excel.”
2.3. Decyzje dotyczące trybów pracy
Ta część dokumentu Noty wyjaśniającej zawiera listę i opis trybów pracy systemu. Zwykle wyróżnia się tryby: tryb normalny, tryb pracy testowej, tryb serwisowy. Nota wyjaśniająca musi zawierać opis zarówno samego reżimu, jak i przypadków, w których jest on wprowadzany.
2.4. Decyzje dotyczące liczby, kwalifikacji i funkcji personelu elektrowni jądrowej
Ta część dokumentu Nota wyjaśniająca reguluje działalność personelu konserwacyjnego i funkcjonalnego. Nota wyjaśniająca musi wskazywać kategorię pracowników, która należy do określonego rodzaju personelu oraz opisywać ich funkcje w ramach systemu.
Na przykład: „Administrator portalu jest odpowiedzialny za:
2.5. Zapewnienie właściwości konsumenckich systemu określonych w specyfikacjach technicznych
Niniejsza część dokumentu Noty Wyjaśniającej tworzona jest w oparciu o wymagania jakościowe produktu określone w specyfikacjach technicznych. W tym miejscu należy opisać parametr, według którego określa się jakość systemu. W nocie objaśniającej wskazano także rozwiązania, dzięki którym w systemie uzyskano tę cechę.
Na przykład: „Odporność na błędy i funkcjonalność modułów oprogramowania oprzyrządowania jest zapewniona dzięki zastosowaniu platform oprogramowania przemysłowego IBM WebSphere Portal, Enterprise Oracle 10g.”
2.6. Skład funkcji i zestaw zadań realizowanych przez system
Ta część dokumentu Noty wyjaśniającej zawiera listę zadań, które system rozwiązuje. W nocie objaśniającej funkcje i zbiór zadań można przedstawić w formie nienumerowanej listy.
2.7. Złożone rozwiązania środki techniczne, jego umieszczenie na miejscu
W tej części dokumentu Noty Wyjaśniającej zawarte są decyzje dotyczące architektury technicznej systemu oraz wymagania dotyczące zestawu środków technicznych niezbędnych do zapewnienia jego prawidłowego funkcjonowania.
Zaleca się umieszczenie wymagań dotyczących zestawu środków technicznych w nocie objaśniającej w formie tabeli.
Na przykład: "
|
Sprzęt |
Specyfikacja techniczna |
|
Serwer bazy danych |
|
|
Wersja do montażu w stojaku |
Nie więcej niż 4U |
|
Architektura procesora |
RISC (64-bitowy) |
|
Częstotliwość procesora |
co najmniej 1,5 GHz |
|
Pamięć podręczna procesora |
Co najmniej 1MB |
|
system operacyjny |
Windows 2003 z dodatkiem SP2 |
|
Możliwa liczba zainstalowanych procesorów |
Co najmniej 4 |
|
Liczba zainstalowanych procesorów |
|
|
Możliwa pojemność pamięci RAM |
32 GB z ECC |
|
Pojemność pamięci RAM |
Minimalnie 8 GB |
|
Dostępność interfejsów |
Interfejsy Ethernet 10/100/1000 Base-T 2 szt.; |
|
Karta graficzna: |
Co najmniej 8MB. |
|
Możliwa liczba zainstalowanych dysków twardych |
Co najmniej 4 |
|
Liczba zainstalowanych dysków |
|
|
Czytelnik |
|
|
Zasilacz |
Parametry wejściowe: |
»
Opisując rozmieszczenie obiektów kompleksu środków technicznych w nocie wyjaśniającej, należy kierować się wymaganiami SNiP 11-2-80 dla budynków kategorii „B”.
2.8. Objętość, skład, metody organizacji, kolejność przetwarzania informacji
Wsparcie informacyjne obejmuje wsparcie informacyjne w maszynie i poza maszyną. Jako maszyna wsparcie informacyjne są Baza Danych (DB), dokumenty wejściowe i wyjściowe pochodzące z systemów zewnętrznych.
Bazę informacji pozamaszynowych tworzą dane zawarte w dokumentach papierowych. Często przy opracowywaniu systemów zautomatyzowanych wykorzystywana jest wyłącznie baza informacji znajdująca się w maszynie, dlatego też główny nacisk w dokumencie Noty wyjaśniającej należy położyć na treść tej sekcji.
Opisując wewnętrzną bazę informacji w dokumencie Noty Wyjaśniającej, należy wskazać dokumenty wejściowe i wyjściowe oraz komunikaty dla wszystkich podsystemów i systemów zewnętrznych.
Na przykład: „Informacje wejściowe dla podsystemu elektroniczne zarządzanie dokumentacją Jest:
Informacje wyjściowe dla podsystemu zarządzania dokumentami elektronicznymi to:
2.9. Skład oprogramowania, języki operacyjne, algorytmy procedur i operacji oraz metody ich realizacji
Ta część dokumentu Noty Wyjaśniającej powinna zawierać technologie i środki umożliwiające rozwój systemu.
Na przykład:
«
»
3 Działania przygotowujące obiekt automatyki do uruchomienia systemu
W tej sekcji dokumentu Noty wyjaśniającej opisano następujące działania:
Z reguły Nota Wyjaśniająca jest najbardziej złożonym dokumentem dotyczącym oprogramowania, wywołującym czasami wiele kontrowersji i dyskusji wokół jego treści. Dlaczego to się dzieje?
Cel noty wyjaśniającej
Powiedzieliśmy już, że w tworzeniu oprogramowania jest to jeden z ważnych etapów. Powinien zawierać opis Twojego systemu z uwzględnieniem wybranych technologii, jak wymaga od nas GOST 34. A dokument Nota wyjaśniająca do Projektu Technicznego, czyli w skrócie PZ, jest jednym z głównych dokumentów tego etapu. I muszę przyznać, że najczęściej to Nota Wyjaśniająca jest najbardziej złożonym dokumentem dotyczącym oprogramowania, wywołującym czasem wiele kontrowersji i dyskusji wokół jego treści.
Skład standardowej noty wyjaśniającej
Nota wyjaśniająca do projektu technicznego zawiera sekcje takie jak:
– Wstęp. W tej sekcji podana jest pełna nazwa systemu i temat rozwoju, a także lista dokumentów, które posłużyły za podstawę pracy nad projektem.
– Cel i zakres. Opisuje cele i zadania, które będą realizowane za pomocą systemu, a także zakres jego wykorzystania.
– Dane techniczne . Ta sekcja jest zwykle podzielona na podsekcje, które opisują: ustawienie zadania tworzenia programu; zastosowany aparat matematyczny; algorytm działania oprogramowania; struktura danych wejściowych i wyjściowych; skład sprzętu i oprogramowania. Konieczne jest również przedstawienie wyników obliczeń i analiz uzasadniających wybór dokładnie tych rozwiązań, które są wymienione w dokumencie.
– Oczekiwane wskaźniki techniczne i ekonomiczne. Sekcja zakłada uzasadnienie ekonomiczne rozwój z uwzględnieniem jego wskaźników technicznych.
– Źródła wykorzystane w rozwoju. Sekcja ta zawiera listę dokumentów, artykułów i publikacji, do których powołano się w tekście.
Standardy not objaśniających
Skład sekcji określa GOST 19.404, jednak norma umożliwia łączenie tych sekcji, jeśli to konieczne, a także dodawanie nowych. W przypadku stosowania GOST serii 34 należy opracować dokument zgodnie z RD 50-34.698. Dokument musi jednak spełniać wymagania ogólnych norm, takich jak GOST 19.105.
Koszt sporządzenia noty wyjaśniającej
Jak najmniejszym kosztem stworzyć dokument programowy, który będzie najbardziej przydatny dla Twojego projektu, który:
– z jednej strony jasno i zrozumiale przedstawia wszystkie niezbędne (a czasem nudne) informacje, w tym skomplikowane szczegóły techniczne;
Przykład „Noty wyjaśniającej” (P2), opracowanej dla zautomatyzowanego systemu pomiarowo-informacyjnego dla komercyjnego pomiaru energii elektrycznej (AIIS KUE) zgodnie z dokumentem. przez I. Wersja z dnia 20 czerwca 2018 r.
Nota wyjaśniająca (P2 zgodnie z GOST 34.201-89) zautomatyzowanego systemu pomiarowo-informacyjnego dla komercyjnego pomiaru energii elektrycznej (AIIS KUE) (przykład)
Utworzono 25.03.2014 11:48:18
Uwaga! Wymagania techniczne hurtowy rynek energii elektrycznej (WEM), do którego linki do punktów znajdują się w przykładowych dokumentach zautomatyzowanych systemów pomiarowych i informatycznych dla komercyjnego opomiarowania energii elektrycznej (AIIS KUE), zmieniają się dość często, ale nie przez nas, ale przez administratora systemu handlowego(centrala). Proszę o wyrozumiałość w tej kwestii
Wszystkie dokumenty walka, które przeszły wiele testów, w tym egzaminy w Federalnym Państwowym Przedsiębiorstwie Unitarnym „Ogólnorosyjski Instytut Badań Naukowych Normalizacji i Certyfikacji w Inżynierii Mechanicznej” (VNIIMASH) firmy ROSSTANDART, dlatego nie ma wątpliwości.
Za zdobycie bezpłatny skróconą wersję dowolnej w formie *.pdf wystarczy kliknąć Strona tytułowa. Dokument otworzy się w przeglądarce z opcją. Pełne wersje dokumenty są płatne, można je uzyskać w formacie za określoną kwotę za pomocą. Każdy dokument może być modyfikowany przez pewien okres czasu, aby spełnić specyficzne wymagania klienta. Trwają dyskusje nad warunkami.
Ministerstwo Rozwój gospodarczy i handel Federacja Rosyjska
ZATWIERDZIŁEM |
||||||||||||||||||||||||||||||||||||||
|
Umowa państwowa nr 000-05-07 z dnia 29 października 2007 r. zawarta pomiędzy Ministerstwem Rozwoju Gospodarczego i Handlu Federacji Rosyjskiej a CJSC PROGNOZ na wykonanie prac na temat „Opracowanie zautomatyzowanego modułu do federalnego monitorowania sytuacji społecznej -rozwój gospodarczy podmiotów Federacji Rosyjskiej w ramach stworzenia jednolitego systemu informacyjnego monitorowania kluczowych wskaźników rozwoju społeczno-gospodarczego Federacji Rosyjskiej oraz monitorowania pracy władz władza państwowa aby je osiągnąć.” Przy opracowywaniu tego dokumentu wykorzystano dokument przewodni dotyczący normalizacji GOST RD 50-34.698-90. 1. Postanowienia ogólne.. 5 1.1. Pełna nazwa systemu... 5 1.2. Dokumenty na podstawie których wykonywany jest projekt.. 5 1.3. Etapy i terminy.. 5 1.4. Cele i przeznaczenie.. 7 1,5. Zgodność rozwiązań projektowych z wymogami bezpieczeństwa.. 8 1.6. Dokumenty regulacyjne i techniczne... 9 2. Opis procesu działania. 10 2.1. Lista zadań... 10 2.2. Główne funkcje realizowane przez Moduł... 11 3. Podstawowe rozwiązania techniczne.. 13 3.1. Struktura modułu, lista podsystemów... 13 3.1.1. Podsystem Scentralizowanego Przechowywania Danych. 14 3.1.2. Komponent interfejsu. 15 3.1.3. Składniki oprogramowania adaptera. 16 3.6.3. Stopień przystosowania się do odchyleń parametrów obiektu automatyki. 26 3.6.4. Dopuszczalne limity modernizacji i rozwoju systemu.. 26 3.6.5. Wymagania dotyczące niezawodności. 27 3.6.6. Wymóg bezpieczeństwa. 27 3.6.7. Wymagania dotyczące ergonomii i estetyki technicznej. 28
|
