GOST 19.402-78

Grupa T55

MEĐUDRŽAVNI STANDARD

jedan sustav programska dokumentacija

OPIS PROGRAMA

Jedinstveni sustav programske dokumentacije. Opis programa.

MKS 35.080

Datum uvođenja 1980-01-01

Dekretom Državnog odbora za standarde SSSR-a od 18. prosinca 1978. N 3350, datum provedbe određen je na 01.01.80.

IZDANJE (siječanj 2010.) s dopunom br. 1, odobreno u rujnu 1981. (IUS 11-81).

1. Ova norma utvrđuje sastav i zahtjeve za sadržaj programskog dokumenta "Opis programa", definiranog GOST 19.101-77.

Norma je u potpunosti u skladu sa ST SEV 2092-80*.
________________
* Pristup ovdje spomenutim međunarodnim i stranim dokumentima može se dobiti putem poveznice na web stranicu http://shop.cntd.ru. - Napomena proizvođača baze podataka.

(Promijenjeno izdanje, dopuna br. 1).

2. Struktura i dizajn dokumenta utvrđuje se u skladu s GOST 19.105-78.

Izrada informativnog dijela (napomene i sadržaj) je obavezna.

3. Opis programa mora sadržavati sljedeće dijelove:

opće informacije;

funkcionalna svrha;

opis logičke strukture;

koristi se tehnička sredstva;

ulazni podaci;

izlaz.

Ovisno o značajkama programa, moguće je uvesti dodatne dijelove ili kombinirati pojedinačne dijelove.

4. U odjeljku " Opće informacije" mora biti naznačeno:

oznaka i naziv programa;

softver potreban za rad programa;

programski jezici na kojima je program napisan.

5. Odjeljak "Funkcionalna svrha" mora naznačiti klase problema koji se rješavaju i (ili) svrhu programa i podatke o funkcionalnim ograničenjima korištenja.

6. U odjeljku "Opis logičke strukture" treba navesti sljedeće:

programski algoritam;

korištene metode;

struktura programa s opisom funkcija komponente i veze među njima;

povezivanje programa s drugim programima.

Opis logičke strukture programa provodi se uzimajući u obzir tekst programa na izvornom jeziku.

3-6. (Promijenjeno izdanje, dopuna br. 1).

7. U odjeljku »Upotrijebljena tehnička sredstva« moraju se navesti vrste elektroničkih računala i uređaja koji se koriste pri izvođenju programa.

način pozivanja programa s odgovarajućeg medija za pohranu;

ulazne točke u program.

Dopušteno je navesti adrese za preuzimanje, podatke o korištenju RAM memorija, glasnoća programa.

9. U odjeljku "Ulazni podaci" potrebno je navesti sljedeće:

karakter, organizaciju i prethodna priprema ulazni podaci;

format, opis i način kodiranja ulaznih podataka.

10. U odjeljku "Izlazni podaci" potrebno je navesti sljedeće:

priroda i organizacija izlaznih podataka;

format, opis i način kodiranja izlaznih podataka.

11. Dopušteno je ilustrirati sadržaj odjeljaka primjerima za objašnjenje, tablicama, dijagramima, grafikonima.

12. Dodatak opisu programa može sadržavati različite materijale koje nije prikladno uključiti u dijelove opisa.

7-12 (prikaz, ostalo). (Dodatno uvedena izmjena br. 1).



Tekst elektroničkog dokumenta
pripremio Kodeks JSC i provjerio prema:
službena objava
Jedinstveni sustav programske dokumentacije:
Kolekcija nacionalni standardi. -
M.: Standardinform, 2010

V.E. Karpov

Ovaj dokument sadrži Kratki opis ESPD standardi čije je poznavanje neophodno studentima za izradu kolegija i projekata vezanih uz izradu programskih sustava. Osim toga, može biti koristan sa stajališta poboljšanja kvalitete softverske dokumentacije općenito.

TEHNIČKE SPECIFIKACIJE (GOST 19.201-78)

1. Opće odredbe

FAZE RAZVOJA (GOST 19.102-77)

OPIS PROGRAMA (GOST 19.402-78)

TEKST PROGRAMA (GOST 19.401-78)

PROGRAM I METODOLOGIJA ISPITIVANJA (GOST 19.301-79)

ZAHTJEVI ZA ISPISANE SOFTVERSKE DOKUMENTE (GOST 19.106-78)

Standardizacija u području programske dokumentacije

Kako krenuti naprijed

Izrada dokumentacije za softver(PS) u skladu s postojećim GOST-ovima

2. Opće karakteristike stanja

2.3. Državni standardi Ruske Federacije (GOST R)

2.4. Međunarodna norma ISO/IEC 12207: 1995-08-01

Možda najneugodnija i najteža faza programerskog rada je izrada programske dokumentacije. Nažalost, obično se to uopće ne podučava ili, u najboljem slučaju, ne obraćaju dužnu pozornost na kvalitetu primljenih dokumenata. Međutim, vladanje ovom vještinom često je jedan od najvažnijih čimbenika koji određuju kvalitetu programera.

Prvo, sposobnost izrade programske dokumentacije određuje profesionalnu razinu programera. Kupac neće ulaziti u sitnice i značajke čak ni najljepšeg programa. Kupac će prvo pročitati dokumentaciju. Veliku ulogu u tome igra i psihološki faktor. Osobito je bivša sovjetska škola programiranja bila (i sada) cijenjena u cijelom svijetu. Moderni domaći programeri prestali su se citirati. Klasa nije ista. Danas se programi više ne pišu, već sastavljaju (a to su “dvije velike razlike”). Dakle, paket programske dokumentacije (u daljnjem tekstu PD) kreiran u “klasičnom” stilu ostavit će najpovoljniji dojam na vašeg kupca ili poslodavca. Štoviše, ako autor PD-a izbjegava izraze poput “klikni na traku za pomicanje...”, “šraf” itd. Nažalost, takvo žargonsko brbljanje obično krije ili manjak misli ili potpunu prazninu (na autora se neizbrisivo dojmila priča jednog njegovog poznanika o izvjesnom “gameru” koji je ili “čavrljao” s nekim ili se bavio “moderiranjem”). ” Ili tako nešto.). Jezik PD-a je vrsta birokratskog, vrlo konzervativnog jezika. Ima svoj poseban šarm. Složite se da pojmovi tvrdi disk, ravni disk, ručni manipulator poput “miš” (ili “kifla”, kako je pisalo u jednom od starih PD paketa) zvuče potpuno drugačije od odgovarajućeg “šrafa”, “ flop” i jednostavno “miš”. Inače, već je došlo do toga da se, kažu, pojavila čak i posebna specijalnost - tehnički pisac, tj. osoba koja zna izraditi programsku dokumentaciju.

Drugo, dobro osmišljen (točnije, kreiran) PD paket spasit će vas od mnogih nevolja. Konkretno, možete se riješiti dosadnih pitanja i neutemeljenih tvrdnji jednostavnim upućivanjem korisnika na dokumentaciju. Riječ je, prije svega, o najvažnijem dokumentu - Projektnom zadatku. O tome ćemo u nastavku, no sada vas možemo podsjetiti na višemilijunsku tužbu protiv IBM-a. Tužbu je pokrenula jedna velika izdavačka kuća, nezadovoljna kvalitetom VT-a i softvera. IBM je dobio slučaj. A pobijedila je samo zato što je predočila projektni zadatak potpisan s obje strane. To se dogodilo davno, još 70-ih godina, ali to ne mijenja bit stvari.

Još jedna stvar. Važno je izraditi prvi PD paket. To će biti dovoljno za izgradnju svih sljedećih na njegovoj osnovi, koristeći ga kao model ili predložak. Ali to se mora učiniti vrlo učinkovito. Ležerno. Vrlo temeljito.

Prvo se morate naoružati GOST-ovima. GOST definira sve. Konkretno, uključuje Jedinstveni sustav programske dokumentacije (USPD) koji nas zanima. Možda je najteže dobiti sam GOST. GOST treba biti samo u tiskanom izvornom obliku. Prodaju se (bar je prije bilo tako) u posebnim trgovinama. Konkretno, za stjecanje standarda u području dokumentacije možete kontaktirati sljedeće organizacije:

• IPK "Standardi izdavanja", Teritorijalni odjel distribucije NTD (trgovina "Standardi"), 17961, Moskva, ul. Donskaja, 8, tel. 236-50-34, 237-00-02, faks/tel. 236-34-48 (u vezi GOST i GOST R).
• VNIIKI Gosstandart Rusije (čitaonica), 103001, Moskva, Granatny per. broj 4, tel. 290-50-94 (u vezi s međunarodnim, stranim normama i drugom znanstveno-tehničkom dokumentacijom).

I bez citata ili sekundarnih izvora. GOST je zakon. I još više, nema interneta (zamislite sud koji izriče kaznu koristeći ispis Kaznenog zakona skinut s neke web stranice). Ne vjeruj nikome osim originalu. Međutim, autor će tada morati pribjeći citiranju ESPD-a, čime se odriče svake odgovornosti.

Počnimo s općim odredbama o Jedinstvenom sustavu programske dokumentacije (koje su također definirane u odgovarajućem standardu GOST 19.001-77).

Jedinstveni sustav programske dokumentacije je skup državnih standarda koji uspostavljaju međusobno povezana pravila za razvoj, izvođenje i promet programa i programske dokumentacije.

ESPD standardi definiraju opće odredbe i temeljne norme, pravila za izradu razvojne dokumentacije, pravila za izradu proizvodne dokumentacije, pravila za izradu dokumentacije za održavanje, pravila za izradu operativne dokumentacije, pravila za rukovanje programskom dokumentacijom i druge norme. ESPD uključuje:

• temeljni i organizacijski i metodološki standardi;
• norme kojima se definiraju oblici i sadržaj programskih dokumenata koji se koriste u obradi podataka;
• standardi koji osiguravaju automatizaciju izrade programskih dokumenata.

Općenito, popis ESPD dokumenata je vrlo opsežan. Konkretno, uključuje sljedeće GOST-ove:

• GOST 19.001-77 ESPD. Opće odredbe.
• GOST 19.101-77 ESPD. Vrste programa i programski dokumenti (reizdano u studenom 1987. s izmjenama i dopunama).
• GOST 19.102-77 ESPD. Faze razvoja.
• GOST 19.103-77 ESPD. Određivanje programa i programskih dokumenata.
• GOST 19.104-78 ESPD. Osnovni natpisi.
• GOST 19.105-78 ESPD. Opći zahtjevi za programske dokumente.
• GOST 19.106-78 ESPD. Zahtjevi za tiskane programske dokumente.
• GOST 19.201-78 ESPD. Tehnički zadatak. Zahtjevi za sadržaj i dizajn.
• GOST 19.202-78 ESPD. Specifikacija. Zahtjevi za sadržaj i dizajn.
• GOST 19.301-79 ESPD. Program i metodologija ispitivanja.
• GOST 19.401-78 ESPD. Tekst programa. Zahtjevi za sadržaj i dizajn.
• GOST 19.402-78 ESPD. Opis programa.
• GOST 19.404-79 ESPD. Objašnjenje. Zahtjevi za sadržaj i dizajn.
• GOST 19.501-78 ESPD. Oblik. Zahtjevi za sadržaj i dizajn.
• GOST 19.502-78 ESPD. Opis primjene. Zahtjevi za sadržaj i dizajn.
• GOST 19.503-79 ESPD. Vodič za programera sustava. Zahtjevi za sadržaj i dizajn.
• GOST 19.504-79 ESPD. Programerski vodič.
• GOST 19.505-79 ESPD. Priručnik za rukovanje.
• GOST 19.506-79 ESPD. Opis jezika.
• GOST 19.508-79 ESPD. Vodič održavanje. Zahtjevi za sadržaj i dizajn.
• GOST 19.604-78 ESPD. Pravila za izmjene programskih dokumenata koji se izvode u tisku.
• GOST 19.701-90 ESPD. Sheme algoritama, programa, podataka i sustava. Konvencije i pravila izvršenja.
• GOST 19.781-90. Softver za sustave za obradu informacija.

Kao što vidite, glavni dio ESPD kompleksa razvijen je 70-ih i 80-ih godina. Neki od ovih standarda su zastarjeli i nisu bez nekih nedostataka. Prvo, oni ne odražavaju neke moderne tendencije dizajn programa i programske dokumentacije; drugo, ovi standardi sadrže višestruko umnožavanje fragmenata programske dokumentacije. Ipak, u nedostatku boljeg, moramo se fokusirati na njih.

Dakle, ESPD standardi pojednostavljuju proces dokumentiranja softverskih sustava. Međutim, prvo, sastav programskih dokumenata predviđen ESPD standardima uopće nije tako "krut" kao što se može činiti: standardi dopuštaju uključivanje dokumentacije o programski sustav(P.S) dodatne vrste, i, drugo, na temelju zahtjeva kupca, dopuštene su neke promjene u strukturi i sadržaju uspostavljenih vrsta PD-a. Štoviše, može se primijetiti da ESPD standardi (a to se odnosi i na sve ostale standarde u području PS - GOST 34, Međunarodni standard ISO/IEC, itd.) su savjetodavne prirode. Činjenica je da u skladu sa Zakonom Ruske Federacije "O normizaciji", ovi standardi postaju obvezni na ugovornoj osnovi - tj. kada se na njih poziva u ugovoru o razvoju (isporuci) softvera.

Prije nego počnemo razmatrati pravila za sastavljanje softverske dokumentacije, potrebno je napraviti sljedeću napomenu. Preporučljivo je svakom dokumentu dati neki uvod. Uvod govori općenito. O relevantnosti, nužnosti itd. Izvođačev cilj ovdje je pokazati značaj i nužnost bavljenja ovim poslom. Početak je obično standardan: "Brojni postojeći sustavi... ... otvaraju stvarne izglede u...", itd. Ovdje se obično ubacuju citati iz govora raznih ličnosti (ovo je čisto psihološki aspekt): "...kao što je rečeno na zadnjem plenumu, kongresu, konferenciji itd.). Možete početi s činjenicom da "...Danas, u eri radikalnih društveno-ekonomskih preobrazbi...itd. Općenito, glavna stvar Nemojte pretjerivati ​​ovdje.

I dalje. Kada opisuje svoj proizvod, programer često brka pojmove komponente i kompleksa. ovo - različiti tipovi programa. Komponenta se definira kao "program koji se smatra jedinstvenom cjelinom, obavlja potpunu funkciju i koristi se samostalno ili kao dio kompleksa", a kompleks je "program koji se sastoji od dvije ili više komponenti i (ili) kompleksa koji obavljaju međusobno povezane funkcionira, a koristi se samostalno ili u sklopu drugog kompleksa."

Prema GOST-u, ova norma (ponovno izdana u studenom 1987.) utvrđuje postupak za izradu i pripremu tehničkih specifikacija za razvoj programa ili softverskog proizvoda za računala, komplekse i sustave, bez obzira na njihovu svrhu i opseg.

Prilikom izrade morate biti izuzetno pažljivi i pažljivi, jer... Često vješto (i kompetentno) sastavljena tehnička specifikacija određuje uspjeh cjelokupnog posla. Tehničke specifikacije su ono što se dogovara s Naručiteljem, koji obično nastoji uvesti što više kontradiktornih i prenapuhanih zahtjeva. Zadatak Izvršitelja je, naprotiv, olakšati mu život. Ali nakon što su stavljeni potpisi s obje strane, prekasno je išta ponavljati.

Projektni zadatak izrađuje se na listovima formata A4 i/ili A3, u pravilu, bez popunjavanja polja lista. Brojevi listova (stranica) stavljaju se na vrhu lista iznad teksta.

Za izmjene i dopune tehničke pozadine u kasnijim fazama razvoja programa ili softverskog proizvoda, izdaje se dodatak. Usklađivanje i odobrenje dopune Tehničke specifikacije provodi istim redoslijedom koji je utvrđen za tehničke specifikacije.

Projektni zadatak mora sadržavati sljedeće odjeljke:

• naziv i opseg primjene;
• osnova za razvoj;
• svrha razvoja;
• tehnički zahtjevi za program ili softverski proizvod;
• faze i stupnjevi razvoja;
• postupak kontrole i prijema;
• aplikacije.

Ovisno o karakteristikama programa ili softverskog proizvoda, moguće je pojasniti sadržaj odjeljaka, uvesti nove dijelove ili kombinirati pojedine.

U poglavlju Naziv i opseg navesti ime, Kratak opis opseg primjene programa ili programskog proizvoda i objekt u kojem se program ili programski proizvod koristi.

U poglavlju Osnova za razvoj mora biti naznačeno:

• dokument(i) na temelju kojeg se provodi razvoj;
• organizacija koja je odobrila ovaj dokument i datum njegovog odobrenja;
• ime i (ili) simbol razvojne teme.

S obzirom na specifičnosti odgojno-obrazovnog procesa, temelj može biti projektni zadatak, narudžba zavoda od __.__. za N ___., ugovor __.__. za N ___. , i tako dalje.

U poglavlju Svrha razvoja Funkcionalna i operativna svrha programa ili softverskog proizvoda mora biti naznačena. Ovdje se možete ograničiti na jednu ili dvije fraze. Glavna stvar je jasno definirati za što je ovaj program.

Na primjer: Program je jezgra automatizirane radne stanice (AWS) za programere kontinuiranih linearnih sustava automatskog upravljanja (ACS), omogućujući korisniku rješavanje problema analize jednostavnih modela.

Poglavlje Tehnički zahtjevi za program ili softverski proizvod treba sadržavati sljedeće pododjeljke:

• zahtjevi za funkcionalne karakteristike;
• zahtjevi pouzdanosti;
• Uvjeti korištenja;
• zahtjevi za sastav i parametre tehničkih sredstava;
• zahtjevi za informacijsku i softversku kompatibilnost;
• zahtjevi za označavanje i pakiranje;
• zahtjevi za prijevoz i skladištenje;
• posebni zahtjevi.

Drugim riječima, tu počinju specifičnosti. Opisuje što bi program trebao raditi i kako bi trebao izgledati.

Zahtjevi za funkcionalne karakteristike. Ovdje treba navesti zahtjeve za sastav funkcija koje se izvode, organizaciju ulaznih i izlaznih podataka, vremenske karakteristike itd.

Na primjer: Program bi trebao omogućiti ... izračunavanje ... izgradnju ... stvaranje ...

Početni podaci: tekstualna datoteka s datim...

Izlazni podaci: grafičke i tekstualne informacije - rezultati analize sustava...; tekstualne datoteke - izvješća o ... dijagnostici stanja sustava i porukama o svim greškama koje su se dogodile.

Zahtjevi pouzdanosti. Moraju se specificirati zahtjevi za osiguranje pouzdanog rada (osiguranje stabilnog rada, praćenje ulaznih i izlaznih informacija, vrijeme oporavka nakon kvara itd.).

Teško je tu nešto "pogoditi". Najbolji scenarij je da vaš program radi samo s apsolutno točnim podacima. Kupac se obično ne slaže s tim, ali možete pokušati.

Na primjer: Program mora raditi s danom proširenom matricom incidenata grafa koji se proučava u skladu s operativnim algoritmom, generirati poruke o pogrešci kada su početni podaci netočno specificirani i podržavati interaktivni način rada unutar mogućnosti koje se daju korisniku.

Uvjeti korištenja. Moraju biti navedeni uvjeti rada (temperatura okoline, relativna vlažnost itd. za odabrane vrste medija za pohranjivanje) pod kojima moraju biti osigurane navedene karakteristike, kao i vrsta usluge, potreban broj i kvalifikacije osoblja.

S ovom točkom obično nema poteškoća. Nažalost, klauzula o profesionalnosti korisnika od strane Kupca se nužno podrazumijeva. Ovo je, naravno, još jedan razlog da pronađete grešku u svom programu. Međutim, ovdje se možemo ograničiti na fraze poput "Uvjeti rada programa podudaraju se s uvjetima rada IBM PC-a i kompatibilnih računala", "Program bi trebao biti dizajniran za neprofesionalnog korisnika." i tako dalje.

Zahtjevi za sastav i parametre tehničkih sredstava. Navesti potreban sastav tehničkih sredstava s naznakom njihovih tehničkih karakteristika.

Ovdje je najvažnije ne zaboraviti ništa i osigurati sve, s jedne strane (inače će ubaciti nekakav IBM PC/XT s jednobojnim zaslonom i bez miša), a s druge strane, ne pretjerati s povećanim zahtjevima, inače će kupac pronaći fleksibilnijeg izvođača.

Na primjer: Morate imati IBM PC - kompatibilno računalo s grafički adapter EGA (VGA). Neophodno prostor na disku- najmanje 600 KB, količina slobodnog RAM-a - najmanje 400 KB. Poželjno je imati EMS vozač i manipulator tipa miš.

Zahtjevi za informacijsku i softversku kompatibilnost. Značajke su iste kao u prethodnom paragrafu. Ovdje treba specificirati zahtjeve za informacijske strukture na ulazu i izlazu i metode rješenja, izvorni kodovi, programski jezici. Gdje je potrebno, mora se osigurati zaštita podataka i programa.

Na primjer: Program mora raditi autonomno pod MS DOS OS verzijom ne nižom od 3.3. Osnovni programski jezik je Turbo Pascal 6.0.

Zahtjevi za označavanje i pakiranje te zahtjevi za prijevoz i skladištenje prilično su egzotični. U opći slučaj ovdje navedite zahtjeve za označavanje softverskog proizvoda, mogućnosti i metode pakiranja. A zahtjevi za prijevoz i skladištenje moraju navesti uvjete prijevoza softverskog proizvoda, lokacije skladištenja, uvjete skladištenja, uvjete skladištenja, razdoblja skladištenja u različitim uvjetima.

Posebni zahtjevi su vrlo važna stvar. Bolje ih je izbjegavati ako je moguće. I to odmah proglasiti.

Na primjer: Ne postoje posebni zahtjevi za vremenske karakteristike programa. Ne postoje posebni zahtjevi za kapacitivne karakteristike programa.

Tehnički i ekonomski pokazatelji. Ova najteža točka za programera nije uvijek tu. Potreban je prije svega kada vam je cilj opravdati ogromnu učinkovitost i važnost posla koji se obavlja. Ova stavka obično vrlo dobro funkcionira za kupca. To je u najmanju ruku najbolje opravdanje za vremenski i novčani iznos razvoja.

U ovom odjeljku treba navesti: procijenjenu ekonomsku učinkovitost, procijenjenu godišnju potrebu (na primjer: očekivani broj poziva kompleksu u cjelini godišnje - 365 radnih sesija), ekonomske prednosti razvoja u usporedbi s najboljim domaćim i stranim uzorcima ili analozi.

Osim toga, preporučljivo je dati definiciju procijenjenog troška razvoja programa i definiciju složenosti programiranja.

Faze i stupnjevi razvoja(o tome će biti više riječi u nastavku) utvrditi potrebne faze razvoja, faze i sadržaj rada (popis programskih dokumenata koji se moraju izraditi, usuglasiti i odobriti), kao i, u pravilu, rokove izrade i odrediti izvođače.

Ovdje su opisani standardni koraci. Glavna stvar je ispravno odrediti vrijeme. Ako je moguće, pokušajte ravnomjerno rasporediti faze po rokovima (i iznosima). Ne zaboravite da svi projekti ne dođu do završne faze. I trebala bi postojati izvješća za svaku fazu. Upamtite također da će radni projekt oduzeti najviše vremena. Ukoliko dokumentaciju ne ispunite na vrijeme, Naručitelj ima puno pravo uopće ne prihvatiti posao sa svim posljedicama.

Glavne i neizostavne faze i faze su sam projektni zadatak, idejni projekt, tehnički i radni projekti.

• Idejni projekt. U ovoj se fazi detaljno razrađuju strukture ulaznih i izlaznih podataka te se određuje oblik njihova prikaza. U razvoju Opći opis algoritam, sam algoritam, struktura programa. U izradi je akcijski plan za razvoj i provedbu programa.
• Tehnički projekt. Sadrži razvijen algoritam za rješavanje problema kao i metode za praćenje početnih informacija. Ovdje se razvijaju alati za obradu pogrešaka i izdavanje dijagnostičkih poruka, utvrđuju se obrasci za prikaz početnih podataka i konfiguracija tehničke opreme.
• Radni nacrt. U ovoj fazi provodi se programiranje i otklanjanje pogrešaka programa, izrada programskih dokumenata, programa i testnih metoda. U pripremi su primjeri testiranja i otklanjanja pogrešaka. Dokumentacija i grafički materijal su finalizirani. Obično se navodi da tijekom razvoja programa treba pripremiti sljedeću dokumentaciju:

• tekst programa;
• opis programa;
• program i metodologija ispitivanja;
• opis primjene;
• korisnički vodič.

Ovo su standardni zahtjevi. Ako se Kupac slaže da se ne može prezentirati cijeli ovaj popis, to znači da njegove namjere prema Vama i Vašem proizvodu nisu ozbiljne.

Možda neće biti nikakvog grafičkog materijala. Pogotovo kada nećete izvještavati o rezultatima svog rada. Ali za ozbiljne projekte ova stavka je potrebna.

Na primjer: Tijekom izrade programa potrebno je pripremiti sljedeći grafički materijal:

• tehnički i ekonomski pokazatelji;
• struktura programa;
• format za prikaz ulaznih podataka programa;
• dijagram općeg algoritma (2 lista);
• osnovni računalni algoritmi;
• primjer kako program radi.

U poglavlju Postupak kontrole i prijema moraju se specificirati vrste ispitivanja i Opći zahtjevi za prihvaćanje posla. Ako je moguće, tada u ovom stavku naznačite da se "kontrola i prihvaćanje razvoja provodi pomoću opreme koju je kupac osigurao", u suprotnom ćete možda morati donijeti opremu sa sobom.

Na primjer: Kontrola i prihvaćanje razvoja provode se na temelju testa testiranja i primjera otklanjanja pogrešaka. Time se provjerava izvršenje svih funkcija programa.

U Prijave Ako je potrebno, tehničke specifikacije dostavljaju:

• popis istraživanja i drugih radova koji opravdavaju razvoj;
• dijagrame algoritama, tablice, opise, obrazloženja, izračune i druge dokumente koji se mogu koristiti tijekom razvoja;

• drugi izvori razvoja.

Ovim standardom utvrđuju se faze razvoja programa, programska dokumentacija, te faze i sadržaj rada:

Faze razvoja	Faze rada
Tehnički zadatak	Opravdanost potrebe izrade programa	Formulacija problema. Zbirka izvorne građe. Odabir i obrazloženje kriterija učinkovitosti i kvalitete izrađenog programa. Opravdanost potrebe istraživačkog rada.
	Istraživački rad	Određivanje strukture ulaznih i izlaznih podataka. Preliminarni odabir metoda rješavanja problema. Opravdanost izvedivosti korištenja prethodno razvijenih programa. Utvrđivanje zahtjeva za tehničkim sredstvima. Obrazloženje temeljne mogućnosti rješenja problema.
	Izrada i odobravanje tehničkih specifikacija	Utvrđivanje programskih zahtjeva. Izrada studije izvodljivosti za izradu programa. Određivanje faza, faza i vremena razvoja programa i dokumentacije za njega. Izbor programskih jezika. Utvrđivanje potrebe istraživačkog rada u kasnijim fazama. Usklađivanje i odobravanje tehničkih specifikacija.
Idejni projekt	Izrada idejnog projekta	Preliminarna izrada strukture ulaznih i izlaznih podataka. Pojašnjenje metoda za rješavanje problema. Izrada općeg opisa algoritma za rješavanje problema. Izrada studije izvodljivosti.
	Odobrenje idejnog projekta	Usklađivanje i suglasnost na idejni projekt
Tehnički projekt	Izrada tehničkog projekta	Pojašnjenje strukture ulaznih i izlaznih podataka. Razvoj algoritma za rješavanje problema. Određivanje oblika prikaza ulaznih i izlaznih podataka. Definicija semantike i sintakse jezika. Razvoj programske strukture. Konačno određivanje hardverske konfiguracije.
	Suglasnost na tehnički projekt	Izrada akcijskog plana za izradu i provedbu programa. Izrada bilješke s objašnjenjem. Usklađivanje i odobrenje tehničkog projekta.
Radni nacrt	Razvoj programa	Programiranje i otklanjanje pogrešaka
	Izrada programske dokumentacije	Razvoj programskih dokumenata u skladu sa zahtjevima GOST 19.101-77.
	Testiranje programa	Izrada, koordinacija i odobravanje programa i metodologije ispitivanja. Provođenje preliminarnih državnih, interresornih, prijemnih i drugih vrsta ispitivanja. Korekcija programa i programske dokumentacije na temelju rezultata ispitivanja.
Provedba	Priprema i prijenos programa	Priprema i prijenos programa i softverske dokumentacije za održavanje i (ili) proizvodnju. Registracija i odobrenje akta prijenosa programa za održavanje i (ili) proizvodnju. Prijenos programa u fond algoritama i programa.

Bilješke:

1. Dopušteno je isključiti drugi stupanj razvoja, au tehnički opravdanim slučajevima - drugi i treći stupanj. Potreba za ovim stupnjevima navedena je u tehničkim specifikacijama.
2. Dopušteno je kombinirati, isključivati ​​faze rada i (ili) njihov sadržaj, kao i uvoditi druge faze rada prema dogovoru s kupcem.

Ova je norma usmjerena na dokumentiranje rezultirajućeg razvojnog proizvoda.

Strogo govoreći, postoje dva različita dokumenta, koji, međutim, imaju mnogo toga zajedničkog. Ovo je OPĆI OPIS (GOST 19.502-78) i OPIS PROGRAMA (GOST 19.402-78). No, s obzirom na to da je jako teško kvalitetno izraditi oboje, bez pribjegavanja gotovo potpunom umnožavanju i kidanju dijelova, dovoljno bi bilo implementirati jedan, općenitiji, “hibridni” dokument. Nazovimo to "Opis programa".

Zapravo, "Opis programa" u svom sadržaju može se nadopuniti odjeljcima i paragrafima preuzetim iz standarda za druge opisne dokumente i priručnike: GOST 19.404-79 ESPD. Objašnjenje, GOST 19.503-79 ESPD. Vodič za programiranje sustava, GOST 19.504-79 ESPD. Programerski vodič, GOST 19.505-79 ESPD. Upute za rukovanje itd. Konkretno, iz Objašnjenja možete uzeti dijagram algoritma, opći opis algoritma i (ili) funkcioniranja programa, kao i obrazloženje usvojenih tehničkih i tehničko-ekonomskih odluka.

Opis programa mora sadržavati informativni dio - napomenu i sadržaj.

Glavni dio dokumenta trebao bi se sastojati od uvodnog dijela i sljedećih dijelova:

• funkcionalna svrha;
• opis logike.
• uvjeti korištenja;
• sastav i funkcije.

Ovisno o specifičnostima programa, mogu se uvesti dodatni dijelovi.

U Uvodni dio Dokument pruža opće informacije o programu - puni naziv, oznaku, njegove moguće primjene itd.

Na primjer: Program "Automatizirano radno mjesto ACS developer" je namijenjen za... implementiran na.... Program podržava...

U poglavlju Svrha navesti svrhu programa i dati opći opis funkcioniranja programa, njegove glavne karakteristike, informacije o ograničenjima nametnutim opsegu programa, a također navesti vrste elektroničkih računala i uređaja koji se koriste tijekom rada.

Na primjer: Program je dizajniran za rješavanje problema... Program predstavlja jezgru automatizirane radne stanice...

Korisnik ima mogućnost..., implementirati..., pokrenuti..., analizirati..., dobiti rezultate analize i obrade..., izgraditi... itd.

U poglavlju " Opis logike" označiti:

• opis strukture programa i njegovih glavnih dijelova

(na primjer: Program uključuje sljedeće:

• korisničko sučelje,
• modul za određivanje staza u grafu,
• modul za izračun prijenosne funkcije,
• modul za konstruiranje amplitudskih i fazno frekvencijskih karakteristika,
• modul za konstruiranje odgovora na polinomski utjecaj,
• uređivač teksta).

• opis funkcija komponenti i veza među njima;

Na primjer: Program se sastoji od šest modula: modul sučelja; definicijski modul...; modul za izračun...; modul...itd..

Modul sučelja izgrađen je na dvije vrste dijaloga: dijalog pitanje-odgovor i dijalog tipa izbornika. Modul sučelja upravlja...

Modul definicije... To je...

Modul za izračun... itd.

• informacije o programskom jeziku;

Na primjer: Program je napisan na jeziku ... korištenjem prevoditelja ...

• opis ulaznih i izlaznih podataka za svaku od komponenti;

Na primjer: ULAZNI PODACI. Ulazni podaci za program su tekstualna datoteka koja opisuje proširenu matricu incidencije grafa sustava koji se proučava.

IZLAZ. Izlaz je:

• grafičke i tekstualne informacije prikazane na ekranu (rezultati analize sustava);
• datoteke u jednoj od grafički formati- preslike slike izgrađenih karakteristika (AFC, PFC, itd.);
• tekstualne datoteke - izvješća o provedenim istraživanjima;
• dijagnostiku stanja sustava i poruke o svim greškama koje se pojave.

• opis logike sastavnih dijelova (po potrebi treba napisati opis dijagrama programa).

Pri opisu logike programa nužna je poveznica na tekst programa.

U poglavlju Sastav i funkcije navesti opis sastava i funkcije programa te metode korištene za rješavanje problema.

U poglavlju Uvjeti korištenja navedeni su uvjeti potrebni za provedbu programa (zahtjevi za tehničkim sredstvima potrebnim za ovaj program i druge programe, Opće karakteristike ulazne i izlazne informacije te zahtjevi i uvjeti organizacijske, tehničke i tehnološke prirode i sl.).

Na primjer: Program je pokrenut osobno računalo(PC) tipa IBM PC/AT. Za rad u interaktivnom načinu rada koriste se zaslon, tipkovnica i miš. Za podršku grafičkog načina rada potreban je EGA (VGA) adapter. Ulazni podaci pohranjuju se na diskete i/ili tvrde diskove. Program radi pod OS-om...

Dodatak opisu može sadržavati referentne materijale (ilustracije, tablice, grafikone, primjere itd.)

I ne zaboravite navesti naziv modula za učitavanje, kao i opis cijelog postupka

Pozivanje i dizanje sustava

Zahtjevi za dizajn programskog teksta prilično su jednostavni i prirodni za kompetentnog programera. Glavna stvar kojom se treba voditi prilikom izrade ovog dokumenta je da tekst programa treba biti čitljiv.

I dalje je obvezno sastavljanje informativnog dijela - napomena i sadržaja.

Glavninu dokumenta trebaju činiti tekstovi jednog ili više odjeljaka koji se nazivaju.

Svačiji tekst programska datoteka počinje "zaglavljem" koje kaže:

• naziv programa,
• Autor,
• datum izrade programa,
• broj verzije,
• datum zadnje izmjene.

Komentari su obavezni, kao i strogo pridržavanje pravila uvlačenja. Zapamtite, čak i nemogućnost izrade softverske dokumentacije može biti opravdana. Ali ružan programski tekst – nikad. Pozivanje na činjenicu da je ovaj tekst razumljiv samom autoru ne uzima se za ozbiljno. Ne treba se sramiti dati programske tekstove drugima na čitanje.

Ispod je primjer tako dobro čitljivog programskog teksta (preuzeto s web stranice Nikolaja Gekhta, e-mail: [e-mail zaštićen], http://users.omskreg.ru/~geht)

/* Windows 98 izvori

Izvorni kod za Windows 98 */ #include "win31.h" #include "win95.h" #include "evenmore.h" #include "oldstuff.h" #include "billrulz.h" #include "monopoly.h" # define INSTALL = HARD char make_prog_look_big; VOID Main () (While (! CraShed) (Display_copyright_message (); Display_bill_rules_message (); do_nothing_loop (); if (first_time_installation) yte_swapfile (); do_nothing_loop (); totilla_screw_up_hpfs_file_system (); search_and_destroy_rest_of_os/2 (); onemogući _netscape (); onemogući_RealPlayer (); disable_Corel_Products(); hang_system(); ) write_something(bilo što); display_copyright_message(); do_nothing_loop(); do_some_stuff(); if(still_not_crashed) ( display_copyright_message(); do_nothing_loop(); basically_run_windows_3.1(); do_nothing_loop ( ); do_nothing_loop(); ) ) if(detect_cache()) disable_cache(); if(fast_cpu()) ( set_wait_states(lots); set_mouse(speed, very_slow); set_mouse(action, jumpy); set_mouse(reaction, ponekad ) ; ) /* printf("Dobrodošli u Windows 3.11"); */ /* printf("Dobrodošli u Windows 95"); */ printf("Dobro došli u Windows 98"); if(system_ok()) crash(to_dos_prompt ) else system_memory = open("a:\swp0001.swp", O_CREATE); while(something) ( sleep(5); get_user_input(); spavanje(5); djelovati_na_unos_korisnika(); spavanje(5); ) create_general_protection_fault();

Ovaj dokument sadrži opis što i kako treba učiniti kako bi se uvjerio (i uvjerio kupca) da program radi ispravno. Zapravo, ovaj dokument je odlučujući za testove prihvaćanja. Dobro osmišljen ispitni program i metodologija ključ su za potpisivanje potvrde o prihvaćanju, tj. stvar za koju ste potrošili toliko truda i vremena.

Formalno, ovaj GOST se koristi za izradu planskih dokumenata i provođenje testnih radova za procjenu spremnosti i kvalitete softverskog sustava. Dokument sadrži opis predmeta i svrhe testiranja, zahtjeve za programsku i programsku dokumentaciju, sredstva i postupak testiranja, kao i opis primjera ispitivanja.

Komponente ovog dokumenta lakše su i jasnije opisane u obliku primjera.

Ispitni objekt

Primjer: Test objekt je program ..., namijenjen za ...

Svrha testiranja

Primjer: Provjera pouzdanosti programa.

Programski zahtjevi

Primjer: Rad programa ne smije dovesti do kvara (fatalnog poremećaja sustava). Organizacija dijaloga treba osigurati zaštitu od unosa netočnih podataka. Program bi trebao omogućiti dijagnostiku stanja sustava i poruke o greškama koje su se dogodile... itd.

Zahtjevi za softversku dokumentaciju

Primjer: Sadržaj softverske dokumentacije prezentirane tijekom testiranja:

• opis programa (GOST 19.402-78);
• program i metodologija ispitivanja (GOST 19.301-79);
• tekst programa (GOST 19.401-78).

Sredstva i postupak ispitivanja

Primjer: Program radi u skladu s radnim uvjetima operativnog sustava MS DOS (verzija ne niža od 3.0) na računalu kao što je IBM PC/AT, kao i na kompatibilnim. Za rad je također potreban EGA (VGA) adapter.

Postupak ispitivanja:

1. Program je pokrenut....
2. Odabran...
3. pritisnut...
4. Redom odabrano...

Test slučajevi

Primjer: Za testiranje su predloženi ... čiji su opisi sadržani u datotekama ... Sadržaj testnih datoteka i rezultati programa dani su u Dodatku 1.

I na kraju, osvrnimo se na posljednje ESPD standard koji se zove

Ova norma utvrđuje pravila za izvršavanje programskih dokumenata za računala, komplekse i sustave, bez obzira na njihovu namjenu i opseg primjene i predviđena ESPD standardima.

Opći zahtjevi. Potrebno je crnom tintom unijeti pojedine riječi, formule, simbole (ručno crtačkim fontom), slova latinične i grčke abecede, kao i crtati dijagrame i crteže u programske dokumente izrađene strojno, strojno i rukopisno. ili tinta.

Tipfeleri i grafičke netočnosti otkrivene tijekom postupka izvođenja mogu se ispraviti brisanjem loše izvedenog dijela teksta (crteža) i nanošenjem ispravljenog teksta (grafike) na isti list strojopisom ili crnom tintom, ovisno o načinu izvođenja. dokument.

Oštećenje listova dokumenta, mrlje i tragovi nepotpuno izbrisanog teksta (grafike) nisu dopušteni.

Programski dokumenti izrađuju se na listovima formata A4. Osim:

• Prihvatljivo je tiskati na A3 listove;
• kod strojnog načina izrade dokumenta dopuštena su odstupanja u veličini listova koja odgovaraju formatima A4 i A3, određena mogućnostima korištenih tehničkih sredstava; na listovima formata A4 i A3, predviđenim izlaznim karakteristikama uređaja za izlaz podataka, kod strojne izrade dokumenta;
• Kod izrade dokumenta tipografskom metodom moguće je koristiti listove tipografskih formata.

Materijali programskog dokumenta raspoređeni su sljedećim redoslijedom:

• naslovni dio:

• list odobrenja (ne ulazi u ukupan broj listova dokumenta);
• naslovna stranica (prva stranica dokumenta);

• informativni dio:

• anotacija;
• sadržaj;

• glavni dio:

• tekst dokumenta (sa slikama, tablicama i sl.);
• popis pojmova i njihovih definicija;
• popis kratica;
• aplikacije;
• predmetni indeks;
• popis referentnih dokumenata;

• dio zapisivanja promjena:

• promijeniti upisni list.

Konstrukcija dokumenta. Ako je potrebno, dopušteno je podijeliti dokument na dijelove. Podjela na dijelove provodi se na razini koja nije niža od odjeljka. Svaki dio popunjava se zasebno, a na kraju sadržaja prvog dijela treba navesti nazive preostalih dijelova.

U dokument je dopušteno uključiti dijelove programskog teksta, oblikovane u skladu s pravilima jezika na kojem je programski tekst napisan.

Sažetak je objavljen na zasebna stranica(stranice), s naslovom "SAŽETAK", numerirani i uključeni u sadržaj dokumenta.

Tekst svakog dokumenta, po potrebi, dijeli se na odlomke, a odlomci u podstavke, neovisno o tome je li dokument podijeljen na dijelove, odjeljke i pododjeljke ili ne.

Naslovi odjeljaka pišu se velikim slovima i postavljaju simetrično u odnosu na desni i lijevi rub teksta. Naslovi pododjeljaka pišu se iz odlomka mala slova(osim prvog kapitala). Rastavljanje riječi u naslovima nije dopušteno. Na kraju naslova nema točke. Preporuča se započeti svaki odjeljak na novom listu.

Odjeljke, pododjeljke, paragrafe i podstavke treba numerirati arapskim brojevima s točkom. Odjeljci moraju imati redni broj (1, 2 itd.)

Tekst dokumenta. Tekst dokumenta treba biti kratak, jasan, isključujući mogućnost pogrešnog tumačenja. Pojmovi i definicije moraju biti jedinstveni i u skladu s utvrđenim standardima, a u nedostatku - općeprihvaćeni u znanstvenoj i stručnoj literaturi, te biti navedeni u popisu pojmova.

Potrebna objašnjenja teksta dokumenta mogu se dati u fusnotama. Bilješka je označena brojem sa zagradom postavljenom na razini gornjeg ruba fonta.

Ako se bilješka odnosi na jednu riječ, znak fusnote stavlja se neposredno uz tu riječ, a ako se odnosi na rečenicu u cjelini, onda na kraju rečenice. Tekst fusnote stavlja se na kraj stranice i od glavnog teksta odvaja crtom duljine 3 cm na lijevoj strani stranice.

Ilustracije. Ilustracije se mogu nalaziti u tekstu dokumenta i (ili) u prilozima. Ilustracije, ako ih u pojedinom dokumentu ima više, numeriraju se arapskim brojevima kroz cijeli dokument.

U dodacima, ilustracije su numerirane unutar svakog dodatka redoslijedom utvrđenim za glavni tekst dokumenta. Upućivanja na ilustracije daju se prema vrsti: “Sl. 12” ili “(Sl. 12)”. Ilustracije mogu imati tematski naslov i tekst opisa koji objašnjava sadržaj ilustracije.

Formule. Formule u dokumentu, ako ih ima više, numeriraju se arapskim brojevima, uz broj se stavlja desna strana stranice, u zagradama na razini formule. Unutar cijelog dokumenta ili njegovih dijelova, ako je dokument podijeljen na dijelove, formule imaju kontinuirani broj.

Upućivanje u tekstu na redni broj formule navodi se u zagradama, na primjer: "u formuli (3)". Kod dijeljenja dokumenta na dijelove, broj dijela se stavlja ispred rednog broja formule i odvaja se od zadnje točke, na primjer: "u formuli (1.4)".

Značenje simbola uključenih u formulu mora biti navedeno neposredno ispod formule. Značenje svakog znaka ispisuje se u novom retku redoslijedom kojim su navedeni u formuli. Prvi redak prijepisa treba započeti riječju "gdje", bez dvotočke iza nje.

Linkovi. Upućivanja na standarde i druge dokumente dopuštena su u dokumentima o politici. Treba se pozvati na dokument u cjelini ili na njegove dijelove (uz naznaku i naziv dokumenta, broj i naziv odjeljka ili priloga).

Dopušteno je navesti samo oznaku dokumenta i (ili) odjeljaka bez navođenja njihovih naziva. Upućivanje na pojedine pododjeljke, paragrafe i ilustracije drugog dokumenta nije dopušteno. Dopuštene su poveznice unutar dokumenta na odlomke, ilustracije i pojedinačne pododjeljke.

Bilješke Bilješke uz tekst i tablice navode samo referentne podatke i podatke s objašnjenjima. Jedna bilješka nije numerirana. Iza riječi "Napomena" stavite točku. Nekoliko bilješki treba redom numerirati arapskim brojevima s točkom. Iza riječi "Napomena" staviti dvotačku. Tekst bilješki može se ispisati samo u jednom intervalu.

Kratice. Nisu dopuštene kratice riječi u tekstu i natpisi ispod ilustracija, osim:

• kratice utvrđene u GOST 2.316-68 i općenito prihvaćene na ruskom jeziku;
• kratice koje se koriste za označavanje programa, njihovih dijelova i načina rada, u jezicima za kontrolu zadataka, u alatima za konfiguraciju programa itd., označene slovima latinične abecede.

Prijave. Ilustrirani materijal, tablice ili popratni tekst mogu se prikazati u obliku priloga. Aplikacije su osmišljene kao nastavak ovog dokumenta na sljedećim stranicama ili izdati kao poseban dokument.

Svaka aplikacija mora započeti sa nova stranica s indikacijom na desnoj strani gornji kut riječi "Aplikacija" i imaju tematski naslov. Ako u dokumentu postoji više od jednog priloga, svi prilozi su numerirani arapskim brojevima (bez znaka br.), na primjer:

Dodatak 1, Dodatak 2 itd.

Prilikom izdavanja aplikacije kao zasebnog dokumenta, na Naslovnica Ispod naziva dokumenta treba navesti riječ "Dodatak", a ako ima više priloga, treba navesti i njegov redni broj.

G O S U D A R S T V E N Y S T A N D A R T S O Y W A S S R

Jedinstveni sustav programske dokumentacije	GOST 19.402-78* (ST SEV 2092-80)
OPIS PROGRAMA
Jedinstveni sustav programske dokumentacije. Opis programa

Dekretom Državnog odbora za standarde SSSR-a od 18. prosinca 1978. br. 3350 utvrđen je datum uvođenja

od 01.01. 1980. godine

1. Ova norma utvrđuje sastav i zahtjeve za sadržaj programskog dokumenta "Opis programa", definiranog GOST 19.101-77.

Norma je u potpunosti u skladu sa ST SEV 2092-80.

2. Struktura i format dokumenta utvrđuju se u skladu s GOST 19.105-78.

Izrada informativnog dijela (napomene i sadržaj) je obavezna.

3. Opis programa mora sadržavati sljedeće dijelove:

opće informacije;

funkcionalna svrha;

opis logičke strukture;

korištena tehnička sredstva;

ulazni podaci;

izlaz.

Ovisno o značajkama programa, moguće je uvesti dodatne dijelove ili kombinirati pojedinačne dijelove.

4. U odjeljku "Opće informacije" potrebno je navesti sljedeće:

oznaka i naziv programa;

softver potreban za rad programa;

programski jezici na kojima je program napisan.

5. Odjeljak "Funkcionalna svrha" mora naznačiti klase problema koji se rješavaju i (ili) svrhu programa i informacije o funkcionalnim ograničenjima primjene.

6. U odjeljku "Opis logičke strukture" treba navesti sljedeće:

programski algoritam;

korištene metode;

strukturu programa s opisom funkcija njegovih sastavnica i međusobnih veza;

povezivanje programa s drugim programima.

Opis logičke strukture programa provodi se uzimajući u obzir tekst programa na izvornom jeziku.

3-6.(Promijenjeno izdanje, dopuna br. 1).

7. U odjeljku “Korišteni tehnički alati” moraju biti naznačene vrste elektroničkih računala i uređaja koji se koriste pri pokretanju programa.

način pozivanja programa s odgovarajućeg medija za pohranu;

ulazne točke u program.

Možete odrediti adrese za preuzimanje, podatke o upotrebi RAM-a i veličinu programa.

9. U odjeljku "Ulazni podaci" potrebno je navesti sljedeće:

priroda, organizacija i prethodna priprema ulaznih podataka;

format, opis i način kodiranja ulaznih podataka.

10. U odjeljku "Izlazni podaci" potrebno je navesti sljedeće:

priroda i organizacija izlaznih podataka;

format, opis i način kodiranja izlaznih podataka.

11. Dopušteno je ilustrirati sadržaj odjeljaka primjerima za objašnjenje, tablicama, dijagramima, grafikonima.

12. Dodatak opisu programa može sadržavati različite materijale koje nije prikladno uključiti u dijelove opisa.

7-12.(Dodatno uvedena izmjena br. 1).

* Ponovno izdanje (studeni 1987.) s promjenom br. 1, odobreno u rujnu 1981. (IUS 11-81)

MEĐUDRŽAVNI STANDARD

Norma je u potpunosti u skladu sa ST SEV 2092-80.

2. Struktura i format dokumenta utvrđuju se u skladu s GOST 19.105-78.

Izrada informativnog dijela (napomene i sadržaj) je obavezna.

3. Opis programa mora sadržavati sljedeće dijelove:

ulazni podaci;

izlaz.

Ovisno o značajkama programa, moguće je uvesti dodatne dijelove ili kombinirati pojedinačne dijelove.

4. U odjeljku "Opće informacije" potrebno je navesti sljedeće:

oznaka i naziv programa;

korištene metode;

strukturu programa s opisom funkcija njegovih sastavnica i međusobnih veza;

povezivanje programa s drugim programima.

Opis logičke strukture programa provodi se uzimajući u obzir tekst programa na izvornom jeziku.

3-6.(Promijenjeno izdanje, dopuna br. 1).

7. U odjeljku »Upotrijebljena tehnička sredstva« moraju se navesti vrste elektroničkih računala i uređaja koji se koriste pri izvođenju programa.

priroda, organizacija i prethodna priprema ulaznih podataka;

format, opis i način kodiranja ulaznih podataka.

10. U odjeljku "Izlazni podaci" potrebno je navesti sljedeće:

priroda i organizacija izlaznih podataka;

format, opis i način kodiranja izlaznih podataka.

11. Dopušteno je ilustrirati sadržaj odjeljaka primjerima za objašnjenje, tablicama, dijagramima, grafikonima.

12. Dodatak opisu programa može sadržavati različite materijale koje nije prikladno uključiti u dijelove opisa.

7-12.(Dodatno uvedena izmjena br. 1).

Dekretom Državnog odbora za standarde SSSR-a od 18. prosinca 1978. br. 3350 utvrđen je datum uvođenja

od 01.01. 1980. godine

1. Ova norma utvrđuje sastav i zahtjeve za sadržaj programskog dokumenta "Opis programa", definiranog GOST 19.101-77.

Norma je u potpunosti u skladu sa ST SEV 2092-80.

2. Struktura i dizajn dokumenta utvrđuje se u skladu s GOST 19.105-78.

Izrada informativnog dijela (napomene i sadržaj) je obavezna.

3. Opis programa mora sadržavati sljedeće dijelove:

• opće informacije;
• funkcionalna svrha;
• opis logičke strukture;
• korištena tehnička sredstva;
• ulazni podaci;
• izlaz.

Ovisno o značajkama programa, moguće je uvesti dodatne dijelove ili kombinirati pojedinačne dijelove.

4. U odjeljku "Opće informacije" potrebno je navesti sljedeće:

• oznaka i naziv programa;
• softver potreban za rad programa;
• programski jezici na kojima je program napisan.

5. Odjeljak "Funkcionalna svrha" mora naznačiti klase problema koji se rješavaju i (ili) svrhu programa i informacije o funkcionalnim ograničenjima primjene.

6. U odjeljku "Opis logičke strukture" treba navesti sljedeće:

• programski algoritam;
• korištene metode;
• strukturu programa s opisom funkcija njegovih sastavnica i međusobnih veza;
• povezivanje programa s drugim programima.

Opis logičke strukture programa provodi se uzimajući u obzir tekst programa na izvornom jeziku.

3-6.(Promijenjeno izdanje, dopuna br. 1).

7. U odjeljku “Korišteni tehnički alati” moraju biti naznačene vrste elektroničkih računala i uređaja koji se koriste pri pokretanju programa.

• način pozivanja programa s odgovarajućeg medija za pohranu;
• ulazne točke u program.

Možete odrediti adrese za preuzimanje, podatke o upotrebi RAM-a i veličinu programa.

9. U odjeljku "Ulazni podaci" potrebno je navesti sljedeće:

• priroda, organizacija i prethodna priprema ulaznih podataka;
• format, opis i način kodiranja ulaznih podataka.

10. U odjeljku "Izlazni podaci" potrebno je navesti sljedeće:

• priroda i organizacija izlaznih podataka;
• format, opis i način kodiranja izlaznih podataka.

11. Dopušteno je ilustrirati sadržaj odjeljaka primjerima za objašnjenje, tablicama, dijagramima, grafikonima.

12. Dodatak opisu programa može sadržavati različite materijale koje nije prikladno uključiti u dijelove opisa.

7-12.(Dodatno uvedena izmjena br. 1).

* Ponovno izdanje (studeni 1987.) s promjenom br. 1, odobreno u rujnu 1981. (IUS 11-81)