Dekretem Państwowego Komitetu ds. Standardów ZSRR z dnia 18 grudnia 1978 r. nr 3350 ustalono datę wprowadzenia
od 01.01. 1980
1. Niniejsza norma określa skład i wymagania dotyczące treści dokumentu programowego „Opis programu”, określonego w GOST 19.101-77.
Norma jest w pełni zgodna z ST SEV 2092-80.
2. Strukturę i format dokumentu ustala się zgodnie z GOST 19.105-78.
Sporządzenie części informacyjnej (adnotacji i treści) jest obowiązkowe.
3. Opis programu musi zawierać następujące sekcje:
informacje ogólne;
cel funkcjonalny;
opis struktury logicznej;
zastosowane środki techniczne;
dane wejściowe;
dane wyjściowe.
W zależności od możliwości programu istnieje możliwość wprowadzenia dodatkowych sekcji lub połączenia poszczególnych sekcji.
4. W rubryce „Informacje ogólne” należy wskazać:
oznaczenie i nazwa programu;
oprogramowanie niezbędne do działania programu;
języki programowania, w których napisany jest program.
5. Sekcja „Cel funkcjonalny” musi wskazywać klasy rozwiązywanych problemów i (lub) cel programu oraz informację o ograniczeniach funkcjonalnych stosowania.
6. W rubryce „Opis struktury logicznej” należy wskazać:
algorytm programu;
stosowane metody;
struktura programu z opisem funkcji jego komponentów i powiązań między nimi;
połączenie programu z innymi programami.
Opis struktury logicznej programu przeprowadza się z uwzględnieniem tekstu programu w języku źródłowym.
3-6.(Wydanie zmienione, zmiana nr 1).
7. W sekcji „Wykorzystane narzędzia techniczne” należy wskazać rodzaje komputerów i urządzeń elektronicznych używanych podczas uruchamiania programu.
sposób wywołania programu z odpowiedniego nośnika danych;
punkty wejścia do programu.
Możesz określić adresy pobierania, informacje o wykorzystaniu pamięci RAM i rozmiarze programu.
9. W sekcji „Dane wejściowe” należy wskazać:
charakter, organizacja i wstępne przygotowanie danych wejściowych;
format, opis i sposób kodowania danych wejściowych.
10. W sekcji „Dane wyjściowe” należy wskazać:
charakter i organizacja danych wyjściowych;
format, opis i sposób kodowania danych wyjściowych.
11. Dopuszczalne jest ilustrowanie treści rozdziałów przykładami objaśniającymi, tabelami, diagramami, wykresami.
12. W załączniku do opisu programu mogą znajdować się różne materiały, których nie należy umieszczać w punktach opisu.
7-12.(Wprowadzono dodatkowo zmianę nr 1).
* Ponowne wydanie (listopad 1987) ze zmianą nr 1, zatwierdzoną we wrześniu 1981 (IUS 11-81)
STANDARD MIĘDZYPAŃSTWOWY
Norma jest w pełni zgodna z ST SEV 2092-80.
2. Strukturę i format dokumentu ustala się zgodnie z GOST 19.105-78.
Sporządzenie części informacyjnej (adnotacji i treści) jest obowiązkowe.
3. Opis programu musi zawierać następujące sekcje:
dane wejściowe;
dane wyjściowe.
W zależności od możliwości programu istnieje możliwość wprowadzenia dodatkowych sekcji lub połączenia poszczególnych sekcji.
4. W rubryce „Informacje ogólne” należy wskazać:
oznaczenie i nazwa programu;
stosowane metody;
struktura programu z opisem funkcji jego komponentów i powiązań między nimi;
połączenie programu z innymi programami.
Opis struktury logicznej programu przeprowadza się z uwzględnieniem tekstu programu w języku źródłowym.
3-6.(Wydanie zmienione, zmiana nr 1).
7. W rubryce „Zastosowane środki techniczne” należy wskazać rodzaje komputerów i urządzeń elektronicznych wykorzystywanych podczas uruchamiania programu.
charakter, organizacja i wstępne przygotowanie danych wejściowych;
format, opis i sposób kodowania danych wejściowych.
10. W sekcji „Dane wyjściowe” należy wskazać:
charakter i organizacja danych wyjściowych;
format, opis i sposób kodowania danych wyjściowych.
11. Dopuszczalne jest ilustrowanie treści rozdziałów przykładami objaśniającymi, tabelami, diagramami, wykresami.
12. W załączniku do opisu programu mogą znajdować się różne materiały, których nie należy umieszczać w punktach opisu.
7-12.(Wprowadzono dodatkowo zmianę nr 1).
Norma ta koncentruje się na dokumentowaniu powstałego produktu rozwojowego.
Ściśle rzecz biorąc, są to dwa różne dokumenty, które jednak mają ze sobą wiele wspólnego. Jest to OPIS OGÓLNY (GOST 19.502-78) i OPIS PROGRAMU (GOST 19.402-78). Ponieważ jednak bardzo trudno jest faktycznie stworzyć oba dokumenty w wysokiej jakości, bez uciekania się do niemal całkowitego powielania i wyrywania kawałków, wystarczyłoby wdrożyć jeden, bardziej ogólny, „hybrydowy” dokument. Nazwijmy to „Opisem programu”.
W rzeczywistości „Opis programu” w swojej treści można uzupełnić sekcjami i akapitami zaczerpniętymi ze standardów dla innych dokumentów opisowych i podręczników: GOST 19.404-79 ESPD. Nota wyjaśniająca, GOST 19.503-79 ESPD. Przewodnik programisty systemu, GOST 19.504-79 ESPD. Przewodnik programisty, GOST 19.505-79 ESPD. Instrukcja obsługi itp. W szczególności z Noty Wyjaśniającej można zaczerpnąć schemat algorytmu, ogólny opis algorytmu i (lub) funkcjonowania programu, a także uzasadnienie podjętych decyzji technicznych i techniczno-ekonomicznych.
Opis programu musi zawierać część informacyjną – adnotację i treść.
Zasadnicza część dokumentu powinna składać się z części wprowadzającej oraz następujących sekcji:
cel funkcjonalny;
opis logiki.
warunki użytkowania;
skład i funkcje.
W zależności od specyfiki programu mogą zostać wprowadzone dodatkowe sekcje.
W Część wprowadzająca Dokument zawiera ogólne informacje o programie - pełną nazwę, oznaczenie, możliwe zastosowania itp.
Na przykład: Program „Zautomatyzowane stanowisko konstruktora dział samobieżnych” przeznaczony jest dla... realizowany w dniu.... Program obsługuje...
W sekcji Zamiar wskazać cel programu i podać ogólny opis funkcjonowania programu, jego główne cechy, informacje o ograniczeniach nałożonych na zakres programu, a także wskazać rodzaje komputerów i urządzeń elektronicznych używanych podczas pracy.
Na przykład: Program przeznaczony jest do rozwiązywania problemów... Program stanowi rdzeń zautomatyzowanej stacji roboczej...
Użytkownik ma możliwość..., wdrażać..., uruchamiać..., analizować..., uzyskiwać wyniki analiz i przetwarzania..., budować... itp.
W dziale „ Opis logiki" wskazać:
opis struktury programu i jego głównych części (na przykład: Program zawiera:
interfejs użytkownika,
moduł wyznaczania ścieżek na grafie,
moduł obliczania funkcji przejścia,
moduł do konstruowania charakterystyk częstotliwościowych amplitudowych i fazowych,
moduł do konstruowania odpowiedzi na wpływ wielomianu,
edytor tekstu)
opis funkcji komponentów i połączeń między nimi;
Na przykład: Program składa się z sześciu modułów: moduł interfejsu; moduł definicji...; moduł obliczeniowy...; moduł...itd..
Moduł interfejsu zbudowany jest na dwóch rodzajach dialogów: dialogu pytanie-odpowiedź oraz dialogu typu menu. Moduł interfejsu steruje...
Moduł definicji... To jest...
Moduł obliczeniowy...etc.
informacje o języku programowania;
Na przykład: Program napisany jest w języku... przy użyciu kompilatora...
opis danych wejściowych i wyjściowych dla każdego ze składników;
Na przykład : DANE WEJŚCIOWE. Danymi wejściowymi dla programu jest plik tekstowy opisujący rozszerzoną macierz częstości wykresu badanego układu.
WYJŚCIE. Dane wyjściowe to:
· informacje graficzne i tekstowe wyświetlane na ekranie (wyniki analizy systemu);
· pliki w jednym z formatów graficznych - kopie obrazu skonstruowanych charakterystyk (pasmo przenoszenia, charakterystyka fazowa itp.);
· pliki tekstowe – raporty z przeprowadzonych badań;
· diagnostyka stanu systemu i komunikaty o wszelkich występujących błędach.
· opis logiki części składowych (w razie potrzeby należy napisać opis schematów programu). Opisując logikę programu, naturalnie konieczne jest powiązanie jej z tekstem programu.
W sekcji Skład i funkcje wskazać opis składu i funkcji programów oraz metod stosowanych do rozwiązywania problemów.
W sekcji Warunki użytkowania wskazane są warunki niezbędne do realizacji programu (wymagania dotyczące środków technicznych niezbędnych dla tego programu i innych programów, ogólna charakterystyka informacji wejściowych i wyjściowych, a także wymagania i warunki o charakterze organizacyjnym, technicznym i technologicznym itp.). ).
Na przykład : Program pracuje na komputerze osobistym (PC) typu IBM PC/AT. Do pracy w trybie interaktywnym wykorzystuje się ekran, klawiaturę i mysz. Do obsługi trybu graficznego wymagana jest przejściówka EGA (VGA). Dane wejściowe są przechowywane na dyskietkach i/lub dyskach twardych. Program działa pod systemem operacyjnym...
Załącznik do opisu może zawierać materiały referencyjne (ilustracje, tabele, wykresy, przykłady itp.)
I nie zapomnij podać nazwy modułu ładującego, a także opisu całej procedury
Wywołanie i uruchomienie systemu
|
Ujednolicony system dokumentacji programu |
GOST 19.402-78*
(ST SEV 2092-80) |
OPIS PROGRAMU |
|
|
Zjednoczony system dokumentacji programu. |
Dekretem Państwowego Komitetu ds. Standardów ZSRR z dnia 18 grudnia 1978 r. nr 3350 ustalono datę wprowadzenia
od 01.01. 1980
1. Niniejsza norma określa skład i wymagania dotyczące treści dokumentu programowego „Opis programu”, określonego w GOST 19.101-77.
Norma jest w pełni zgodna z ST SEV 2092-80.
2. Strukturę i projekt dokumentu ustala się zgodnie z GOST 19.105-78.
Sporządzenie części informacyjnej (adnotacji i treści) jest obowiązkowe.
3. Opis programu musi zawierać następujące sekcje:
W zależności od możliwości programu istnieje możliwość wprowadzenia dodatkowych sekcji lub połączenia poszczególnych sekcji.
4. W rubryce „Informacje ogólne” należy wskazać:
5. Sekcja „Cel funkcjonalny” musi wskazywać klasy rozwiązywanych problemów i (lub) cel programu oraz informację o ograniczeniach funkcjonalnych stosowania.
6. W rubryce „Opis struktury logicznej” należy wskazać:
Opis struktury logicznej programu przeprowadza się z uwzględnieniem tekstu programu w języku źródłowym.
3-6.(Wydanie zmienione, zmiana nr 1).
7. W sekcji „Wykorzystane narzędzia techniczne” należy wskazać rodzaje komputerów i urządzeń elektronicznych używanych podczas uruchamiania programu.
Możesz określić adresy pobierania, informacje o wykorzystaniu pamięci RAM i rozmiarze programu.
9. W sekcji „Dane wejściowe” należy wskazać:
10. W sekcji „Dane wyjściowe” należy wskazać:
11. Dopuszczalne jest ilustrowanie treści rozdziałów przykładami objaśniającymi, tabelami, diagramami, wykresami.
12. W załączniku do opisu programu mogą znajdować się różne materiały, których nie należy umieszczać w punktach opisu.
7-12.(Wprowadzono dodatkowo zmianę nr 1).
*
Ponowne wydanie (listopad 1987) ze zmianą nr 1, zatwierdzoną we wrześniu 1981 (IUS 11-81)
GOST 19.402-78
Grupa T55
STANDARD MIĘDZYPAŃSTWOWY
Ujednolicony system dokumentacji programu
OPIS PROGRAMU
Ujednolicony system dokumentacji programu. Opis programu.
MKS 35.080
Data wprowadzenia 1980-01-01
Dekretem Państwowego Komitetu ds. Standardów ZSRR z dnia 18 grudnia 1978 r. N 3350 datę wdrożenia ustalono na 01.01.80
WYDANIE (styczeń 2010) z poprawką nr 1, zatwierdzoną we wrześniu 1981 (IUS 11-81).
1. Niniejsza norma określa skład i wymagania dotyczące treści dokumentu programowego „Opis programu”, określonego w GOST 19.101-77.
Norma jest w pełni zgodna z ST SEV 2092-80*.
________________
* Dostęp do wymienionych tutaj dokumentów międzynarodowych i zagranicznych można uzyskać, klikając link do strony internetowej http://shop.cntd.ru. - Uwaga producenta bazy danych.
(Wydanie zmienione, zmiana nr 1).
2. Strukturę i projekt dokumentu ustala się zgodnie z GOST 19.105-78.
Sporządzenie części informacyjnej (adnotacji i treści) jest obowiązkowe.
3. Opis programu musi zawierać następujące sekcje:
informacje ogólne;
cel funkcjonalny;
opis struktury logicznej;
zastosowane środki techniczne;
dane wejściowe;
dane wyjściowe.
W zależności od możliwości programu istnieje możliwość wprowadzenia dodatkowych sekcji lub połączenia poszczególnych sekcji.
4. W rubryce „Informacje ogólne” należy wskazać:
oznaczenie i nazwa programu;
oprogramowanie niezbędne do działania programu;
języki programowania, w których napisany jest program.
5. Sekcja „Cel funkcjonalny” musi wskazywać klasy rozwiązywanych problemów i (lub) cel programu oraz informację o ograniczeniach funkcjonalnych użytkowania.
6. W rubryce „Opis struktury logicznej” należy wskazać:
algorytm programu;
stosowane metody;
struktura programu z opisem funkcji jego komponentów i powiązań między nimi;
połączenie programu z innymi programami.
Opis struktury logicznej programu przeprowadza się z uwzględnieniem tekstu programu w języku źródłowym.
3-6. (Wydanie zmienione, zmiana nr 1).
7. W rubryce „Zastosowane środki techniczne” należy wskazać rodzaje komputerów i urządzeń elektronicznych wykorzystywanych podczas uruchamiania programu.
sposób wywołania programu z odpowiedniego nośnika danych;
punkty wejścia do programu.
Możesz określić adresy pobierania, informacje o wykorzystaniu pamięci RAM i rozmiarze programu.
9. W sekcji „Dane wejściowe” należy wskazać:
charakter, organizacja i wstępne przygotowanie danych wejściowych;
format, opis i sposób kodowania danych wejściowych.
10. W sekcji „Dane wyjściowe” należy wskazać:
charakter i organizacja danych wyjściowych;
format, opis i sposób kodowania danych wyjściowych.
11. Dopuszczalne jest ilustrowanie treści rozdziałów przykładami objaśniającymi, tabelami, diagramami, wykresami.
12. W załączniku do opisu programu mogą znajdować się różne materiały, których nie należy umieszczać w punktach opisu.
7-12. (Wprowadzono dodatkowo zmianę nr 1).
Tekst dokumentu elektronicznego
przygotowane przez Kodeks JSC i zweryfikowane względem:
oficjalna publikacja
Ujednolicony system dokumentacji programu:
Zbiór norm krajowych. -
M.: Standartinform, 2010
