Pravila za izradu programske dokumentacije

Ovaj vodič odnosi se na izradu izvješća o programima koje su izradili studenti tijekom praktične nastave iz različitih disciplina. Opće odredbe ovih pravila primjenjuju se i pri izradi pojedinih dijelova nastavnih i kvalifikacijskih radova, izvješća o industrijskoj i nastavnoj praksi te znanstveno-istraživačkog rada studenata, ako je rezultat ili neka faza takvog rada izrađeni programski proizvod ili programski modul.

Softverska dokumentacija je sastavni dio softverskog proizvoda i mora biti sastavljena u skladu s Jedinstvenim sustavom softverske dokumentacije (USPD - GOST serija 19). U sklopu odgojno-obrazovnog rada dopušteno je cjelokupni sadržaj programske dokumentacije obuhvatiti jednim „programskim izvješćem“, a formalni uvjeti za izradu takvog izvješća odgovaraju uvjetima za istraživačko izvješće. Ovaj odjeljak ističe ključne točke ESPD državnih standarda.

Programska dokumentacija, osim formalnih dokumenata (specifikacija, popis izvornih nositelja, obrazac i sl.), uključuje:

• projektni zadatak (svrha, opseg primjene programa, zahtjevi za program);
• tekst programa (zapis programa s potrebnim komentarima);
• opis programa (podaci o logičkoj strukturi i funkcioniranju programa);
• objašnjenje (dijagram algoritma, opći opis funkcioniranja algoritma i/ili programa, obrazloženje donesenih odluka);
• operativni dokumenti.

Programski dokument "Objašnjenje" izrađuje se u fazi idejnih ili tehničkih rješenja programa. Obično se ne koristi u fazi detaljnog dizajna.

Operativni dokumenti uključuju:

• opis aplikacije (informacije o namjeni programa, opsegu, korištenim metodama, klasi problema koje treba riješiti, ograničenjima za korištenje, minimalnoj konfiguraciji hardvera);
• vodič za programere sustava (informacije za provjeru, osiguranje funkcioniranja i prilagodbu programa za uvjete određene primjene);
• programerski vodič (informacije za rad s programom);
• korisnički priručnik (informacije za osiguranje komunikacije između operatera i računalnog sustava tijekom izvođenja programa);
• opis jezika (opis sintakse i semantike jezika);
• priručnik za održavanje (informacije za korištenje testnih i dijagnostičkih programa pri servisiranju tehničke opreme)

Glavni dio softverske dokumentacije sastavlja se u fazi detaljnog projektiranja. Potreba za određenim dokumentom utvrđuje se u fazi izrade tehničke specifikacije. Dopušteno je objedinjavanje određenih vrsta dokumenata.

Radni dokument "Opis jezika" uključuje se u programsku dokumentaciju ako razvijeni programski proizvod implementira određeni programski jezik, upravljanje zadacima, organizaciju računalnih procesa i sl.

Radni dokument „Maintenance Manual” uključen je u dokumentaciju softvera ako razvijeni softverski proizvod zahtijeva korištenje testnih ili dijagnostičkih programa.

Projektni zadatak uključuje:

• uvod (naziv, kratak opis područja primjene programa);
• osnove izrade (dokumenti na temelju kojih se provodi izrada, organizacija koja je odobrila dokumente, datum odobrenja, naziv i oznaka teme izrade);
• svrha razvoja (funkcionalna i operativna svrha programa);
• zahtjevi za program i programsku dokumentaciju;
• tehnički i ekonomski pokazatelji;
• faze i stupnjevi razvoja;
• postupak kontrole i prijema.

Najvažniji dio tehničke specifikacije je odjeljak "zahtjevi". » Ovaj odjeljak sadrži:

• zahtjevi za funkcionalne karakteristike (sastav funkcija koje se izvode, organizacija ulaznih i izlaznih podataka, vremenske karakteristike);
• zahtjevi pouzdanosti (osiguravanje stabilnog rada, praćenje ulaznih i izlaznih informacija, vrijeme oporavka nakon kvara);
• zahtjevi za informacijskom i programskom kompatibilnošću (zahtjevi za informacijske strukture na ulazu i izlazu, metode rješenja, izvorni kodovi, programski jezici i softver; zahtjevi za zaštitu informacija);
• zahtjevi za sastav i parametre tehničkih sredstava;
• zahtjevi za softversku dokumentaciju.

Ovaj odjeljak može sadržavati zahtjeve za označavanje, pakiranje, prijevoz i skladištenje, kao i radne uvjete.

Uz zahtjeve izričito opisane u tehničkim specifikacijama, trebate se pridržavati općeprihvaćenih pravila za razvoj programa, uzimajući u obzir odabranu programsku paradigmu:

1. Program ne smije sadržavati suvišne elemente (svi programski elementi odgovaraju zadatku koji se radi: nema petlji, nizova i sl. elemenata koji se mogu izostaviti).
2. Algoritam mora biti strukturiran: za funkcionalni programski stil - odgovarajuća raščlamba na funkcije (postupke), za objektno orijentirani stil - odgovarajuća hijerarhija klasa. Svaka funkcija (metoda klase) mora implementirati točno jednu akciju.
3. Funkcije (metode klase) moraju imati parametre. Korištenje globalnih varijabli u funkcijama treba izbjegavati.
4. Program mora pažljivo koristiti memoriju: raditi s dinamičkim nizovima, ne smije sadržavati neiskorištene memorijske blokove ili nepotrebne varijable.
5. Moraju se provjeriti rasponi korisnički unesenih vrijednosti i parametara koji se prosljeđuju između programskih modula.
6. Kada koristite bilo koju gotovu komponentu (funkcije knjižnice, klase) u programu, ako neka funkcija ili metoda klase može zakazati, potrebno je to provjeriti bez oslanjanja na beznačajnost vjerojatnosti takvog događaja.
7. Program mora biti konfigurabilan (važni parametri programa trebaju biti odvojeni u jedan blok).

Programski tekst je simbolički zapis u izvornom ili posrednom jeziku ili simbolički prikaz strojnih kodova. Tekst programa formatiran je monospace fontom (Courier, Lucida Console, itd.) u skladu s općeprihvaćenim standardima dizajna:

1. Broj operatora po retku mora biti 1.
2. Sve izjave uključene u složenu izjavu moraju biti pomaknute udesno za isti broj pozicija, a operatorske zagrade (to jest, ono što ograničava složenu izjavu) koje pripadaju istom bloku moraju biti postavljene na sljedeći način: početna zagrada mora biti na da isti redak kao naredba koja otvara blok, a završni red mora biti u istom stupcu s kojim počinje naredba koja otvara blok. Dopušteno je staviti početnu zagradu u redak koji slijedi nakon izjave koja otvara blok, u istom stupcu s kojom ta izjava počinje.
3. Cijeli redak izvornog teksta programa mora se nalaziti u jednom tipografskom retku (do 80 znakova ovisno o fontu). Nepoštivanje ovog pravila ukazuje na preveliku ugniježđenost blokova, što znači neuspješan algoritam ili strukturu programa. U tom slučaju preporuča se ponovno razmisliti o strukturi programa, uvesti dodatne funkcije, zamijeniti neke velike dijelove koda njihovim pozivima, ponoviti algoritam itd.
4. Ako sintaksa jezika dopušta, preporučljivo je znakove operacije odvojiti razmacima od operanda. Kao i u uobičajenom tekstu, nakon zareza mora slijediti razmak.
5. Definicije funkcija ili logički dijelovi programa trebaju biti odvojeni jedni od drugih praznim redovima.
6. Identifikatori (imena varijabli, tipova, potprograma) moraju biti toliko smisleni da čitatelj programskog teksta može razumjeti njihovo značenje bez prisutnosti autora. Ako je potrebno, deklaracija varijable ili tipa može biti popraćena komentarom.
7. Tekst programa mora sadržavati komentare koji odražavaju funkcionalnu svrhu pojedinog programskog bloka i strukturu programa.

Dokument "Opis programa" sadrži:

• opći podaci (oznaka, naziv programa, softver potreban za rad programa, programski jezici na kojima je program napisan);
• funkcionalna namjena (klase zadataka koje treba riješiti, informacije o funkcionalnim ograničenjima primjene);
• opis logičke strukture (programski algoritam, korištene metode, struktura programa s opisom sastavnica i veza među njima);
• korištena tehnička sredstva (vrste računala i uređaja koji se koriste pri izvođenju programa);
• poziv i učitavanje (način pozivanja programa s odgovarajućeg medija za pohranu);
• ulazni podaci (priroda, organizacija i prethodna priprema ulaznih podataka, kao i njihov oblik, opis i način kodiranja);
• izlazni podaci (priroda i organizacija izlaznih podataka, kao i njihov format, opis i metoda kodiranja).

Uz opis logičke strukture programa treba priložiti blok dijagram programa.

Dokument "Opis programa" također može sadržavati dijagrame podataka, dijagrame interakcije programa, dijagrame resursa sustava itd., dizajnirane u skladu s GOST 19.701-90.

Dokument "Opis primjene" odnosi se na operativne dokumente i sastoji se od sljedećih odjeljaka:

• svrha programa (mogućnosti, glavne karakteristike, ograničenja u opsegu primjene);
• uvjeti korištenja (zahtjevi za hardver i programsku opremu, opće karakteristike ulaznih i izlaznih informacija, te zahtjevi i uvjeti organizacijske, tehničke i tehnološke prirode);
• opis problema (navedene su definicije problema i metode za njegovo rješavanje);
• ulaznih i izlaznih podataka.

Vodič za programera sustava

Dokument "Upute za programiranje sustava" odnosi se na operativne dokumente i uključen je u programsku dokumentaciju ako razvijeni programski proizvod zahtijeva održavanje od strane programera sustava. Dokument se sastoji od sljedećih odjeljaka:

• opći podaci o programu (svrha i funkcije programa, podaci o hardveru i softveru koji osiguravaju izvođenje ovog programa);
• struktura programa (podaci o strukturi, odnosi između programskih modula i s drugim programima);
• postavljanje programa (postavljanje sastava tehničkih sredstava, odabir funkcija i dr.);
• verifikacija programa (metode i tehnike verifikacije, test slučajevi, metode rada, rezultati);
• dodatne mogućnosti;
• poruke sistemskom programeru (tekst poruka izdanih tijekom konfiguracije, testiranja programa, tijekom izvođenja programa i opis radnji koje se moraju poduzeti kao odgovor na te poruke).

Dokument "Programerski vodič" odnosi se na operativne dokumente i uključuje se u programsku dokumentaciju ako razvijeni programski proizvod zahtijeva održavanje od strane programera. Dokument se sastoji od sljedećih odjeljaka:

• namjena i uvjeti korištenja programa (svrha i funkcije programa, podaci o hardveru i softveru koji osiguravaju izvođenje ovog programa);
• značajke programa (vremenske karakteristike, načini rada, načini praćenja ispravnosti izvršenja itd.);
• pristup programu (načini prijenosa upravljačkih i podatkovnih parametara);
• ulazni i izlazni podaci (format i kodiranje);
• poruke (tekst poruka izdanih programeru ili operateru tijekom izvođenja programa i opis radnji koje se moraju poduzeti kao odgovor na te poruke).

Dokument "Priručnik za rukovanje" odnosi se na radne dokumente i sastoji se od sljedećih odjeljaka:

• svrha programa (informacije dovoljne za razumijevanje funkcija programa i njegovog rada);
• uvjeti za izvođenje programa (minimalni i/ili maksimalni skup hardvera i softvera itd.);
• izvršavanje programa (niz radnji operatera koje osiguravaju učitavanje, pokretanje, izvođenje i prekid programa; opisuje funkcije, formate i moguće verzije naredbi kojima operater učitava i kontrolira izvođenje programa, kao i odgovore programa na ove naredbe);
• poruke operateru (tekstovi poruka izdanih operateru tijekom izvođenja programa i opis radnji koje se moraju poduzeti kao odgovor na te poruke).

Prema ovom GOST-u, :

• Naslovni dio.
• Informacijski dio.

• Glavni dio.
• Dio registracije promjena.

A.V.HHHHH-HH XX XX-H

:

• Naslovni dio:
• Informativni dio:
  • anotacija;
  • sadržaj;
• Glavni dio:
  • aplikacije;
  • dio zapisivanja promjena:
  • promijeniti upisni list.

Pravila za izradu programske dokumentacije

Dopušteno je objedinjavanje pojedinih vrsta operativnih isprava (osim popisa operativnih isprava i obrasca). Potreba za kombiniranjem ovih dokumenata navedena je u tehničkim specifikacijama. Spojenom dokumentu dodjeljuje se naziv i oznaka jednog od spojenih dokumenata.

Vrste programskih dokumenata i njihov sadržaj

Do vrha
GOST 19.103-77 (Označavanje programa i programskih dokumenata)
Iz ovog GOST-a dobivamo strukturu označavanja programa i programskih dokumenata. Ispod su najvažniji dijelovi.

Struktura oznake programa i njegov programski dokument – ​​specifikacije:

• Ovom normom utvrđuju se oblici, veličine, mjesto i postupak popunjavanja glavnih natpisa odobrenog lista i naslovne stranice u programskim dokumentima predviđenim ESPD normama, bez obzira na načine njihove provedbe.

• Ova norma utvrđuje opće zahtjeve za izvršavanje programskih dokumenata za računala, komplekse i sustave, bez obzira na njihovu svrhu i opseg primjene i predviđene standardima Jedinstvenog sustava programske dokumentacije (USPD) za bilo koju metodu izvršavanja dokumenata na različitim nositelji podataka.
• Programski dokument sastoji se od sljedećih konvencionalnih dijelova:
  • titula;
  • informativni;
  • Osnovni, temeljni;
  • upis promjena.
• Naslovnica se sastoji od lista odobrenja i naslovne stranice. Pravila za izradu lista odobrenja i naslovne stranice utvrđena su u skladu s GOST 19.104-78.
• Informativni dio treba se sastojati od sažetka i sadržaja.
  • Potreba uključivanja informacijskog dijela u različite vrste programskih dokumenata utvrđena je relevantnim ESPD standardima za te dokumente.
  • Anotacija sadrži podatke o namjeni dokumenta i kratak sažetak njegovog glavnog dijela.
  • Sadržaj uključuje popis zapisa o strukturnim elementima glavnog dijela dokumenta, od kojih svaki uključuje:
    • oznaka strukturnog elementa (broj odjeljka, pododjeljka itd.);
    • naziv strukturnog elementa;
    • adresu strukturnog elementa na mediju za pohranu (na primjer, broj stranice, broj datoteke itd.).
• Sastav i struktura glavnog dijela programskog dokumenta utvrđeni su ESPD standardima za relevantne dokumente.
• Dio registracije promjena (mora biti prisutan u svakom programskom dokumentu)
  • Svaka promjena u programskom dokumentu bilježi se u ovom dijelu u skladu sa zahtjevima GOST 19.603-78.

Do vrha
==================================
GOST 19.106-78* (Opći zahtjevi za programske dokumente izrađene u tiskanom obliku
put)
Iz ovog GOST-a dobivamo opća pravila za tiskanu metodu izvršavanja programskih dokumenata. Ispod su najvažniji dijelovi.

• Ova norma utvrđuje pravila za izvođenje programskih dokumenata za računala, komplekse i sustave, bez obzira na njihovu namjenu i opseg primjene i predviđena standardima Jedinstvenog sustava programske dokumentacije (USPD) za tiskanu metodu izvođenja.
• Norma se ne odnosi na programski dokument “Programski tekst”.
• Sastav i struktura programskog dokumenta utvrđuje se u skladu s GOST 19.105-78.
• Programski dokument se izvodi na jednoj strani lista, u dva intervala; dopušteno u jednom ili jednom i pol intervalu.
• Programske dokumente izrađuju:
  • na listovima formata A4 (GOST 2.301-68) - pri pripremi dokumenta tipkanjem ili rukopisom (obrazac 1). Dopušteno je crtanje na A3 listovima.

• 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.);
    • aplikacije;
    • popis pojmova, popis kratica, popis slika, popis tablica, predmetno kazalo, popis referentnih dokumenata;
  • dio zapisivanja promjena:
    • promijeniti upisni list.

• Sažetak se stavlja na posebnu (numeriranu) stranicu s naslovom „SAŽETAK” i nije numeriran kao odjeljak.
  • Anotacija označava izdanje programa i ukratko opisuje svrhu i sadržaj dokumenta. Ako se dokument sastoji od više dijelova, u napomeni se navodi ukupan broj dijelova.
• Sadržaj dokumenta nalazi se na zasebnoj (numeriranoj) stranici (stranicama) iza napomene, s naslovom "SADRŽAJ", nije numeriran kao odjeljak i uključen je u ukupan broj stranica dokumenta.
• 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 malim slovima (osim prvog velikog).
• Rastavljanje riječi u naslovima nije dopušteno. Na kraju naslova nema točke.

• Udaljenost između naslova i sljedećeg teksta, kao i između naslova odjeljaka i pododjeljaka, treba biti jednaka:
  • pri izvršavanju dokumenta tipkanjem - dva intervala.
• Za odjeljke i pododjeljke, čiji je tekst napisan na istoj stranici s tekstom prethodnog odjeljka, razmak između posljednjeg reda teksta i sljedećeg naslova treba biti jednak:
  • pri izvršavanju dokumenta tipkanom metodom - tri tipkana intervala.
• Odjeljke, pododjeljke, paragrafe i podstavke treba numerirati arapskim brojevima s točkom.
• Unutar odjeljka moraju postojati kontinuirani brojevi za sve pododjeljke, paragrafe i podstavke uključene u ovaj odjeljak.
• Numeracija pododjeljaka uključuje broj odjeljka i redni broj pododjeljka uključenog u ovaj odjeljak, odvojene točkom (2.1; 3.1 itd.).
• Ako postoje odjeljci i pododjeljci, uz broj pododjeljka iza točke dodaje se redni broj točke i podtočke (3.1.1, 3.1.1.1 itd.).

• 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 slova, na primjer: „ispisni uređaj 2) . " ili "papir 5) ".
  • 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, ako ih u dokumentu ima više, numeriraju se arapskim brojevima kroz cijeli dokument.
• Formule u dokumentu, ako ih ima više, numeriraju se arapskim brojevima, a broj se stavlja na desnoj strani stranice, u zagradi na razini formule.
• Značenje simbola i numeričkih koeficijenata 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.
• U programskim dokumentima dopušteno je pozivanje na standarde (osim na standarde poduzeća), tehničke specifikacije i druge dokumente (na primjer, dokumente državnih nadzornih tijela, pravila i propise Državnog odbora za izgradnju SSSR-a). Pri upućivanju na norme i tehničke specifikacije navedena je njihova oznaka.
• Treba se pozvati na dokument u cjelini ili na njegove dijelove (uz naznaku i naziv dokumenta, broj i naziv odjeljka ili priloga). Kod ponavljanja referenci na odjeljak ili aplikaciju navodi se samo broj.
• 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.
• Nisu dopuštene kratice riječi u tekstu i natpisi ispod ilustracija.
• Ilustrirani materijal, tablice ili popratni tekst mogu se prikazati u obliku priloga.
• Svaka prijava mora započeti na novoj stranici s naznakom "DODATAK" u gornjem desnom kutu i imati tematski naslov koji se ispisuje simetrično u odnosu na tekst velikim slovima.

Do vrha
==================================
GOST 19.604-78* (Pravila za izmjene programskih dokumenata dovršena
u tiskanom obliku)
Iz ovog GOST-a dobivamo opća pravila za izmjene programskih dokumenata (kao rezultat toga, za izradu projekta potreban nam je samo list za registraciju promjena).

• Ovaj standard utvrđuje pravila za izmjene programskih dokumenata predviđenih standardima Jedinstvenog sustava programske dokumentacije (USPD) i tiskanih.

Zbog značajne količine informacija u ovom GOST-u i radi uštede prostora na ovoj stranici, preporučujem da sami pregledate GOST 19.604-78*. Možete vidjeti gotov primjer dizajna "registracijskog lista promjena" u bilo kojem programskom dokumentu u odjeljku PREUZIMANJE

Dizajn programa prema GOST-u (kako)

Računalni programi izrađuju se u skladu sa zahtjevima Jedinstvenog sustava programske dokumentacije (USPD). ESPD je skup GOST-ova koji utvrđuju pravila za dizajn, sadržaj i strukturu programskih dokumenata.
Ovaj način rada sadrži izvatke iz ESPD-a. Potpune informacije mogu se dobiti izravno iz GOST-ova.

Kratki algoritam za izradu programa

Na slici su ukratko prikazani algoritam izrade programa i vrste programskih dokumenata. Postupak registracije je detaljnije opisan u nastavku.

Izrada programskog dokumenta

Programski dokument je dokument koji sadrži podatke potrebne za razvoj, proizvodnju, održavanje i rad programa.

Svaki pojedinačni programski dokument sastavljen je u skladu sa (zajedničkim za sve ESPD dokumente) zahtjevima GOST 19.101-77, GOST 19.103-77, GOST 19.104-78, GOST 19.105-78, GOST 19.106-78, GOST 19.604-78 ( detaljniji opis ovih GOST-ova slijedi u nastavku) i GOST-a za određeni programski dokument.

Opći zahtjevi za programske dokumente. GOST 19.105 - 78

GOST 19.105-78 utvrđuje opće zahtjeve za pripremu programskih dokumenata.

Prema ovom GOST-u, programski dokument treba se sastojati od sljedećih dijelova:

• Naslovni dio. Naslovnica se sastoji od lista odobrenja i naslovne stranice. Pravila za izradu lista odobrenja i naslovne stranice opisana su u nastavku.
• Informacijski dio. Informativni dio treba se sastojati od sažetka i sadržaja.
  • Anotacija sadrži podatke o namjeni dokumenta i kratak sažetak njegovog glavnog dijela.
  • Sadržaj uključuje popis zapisa o strukturnim elementima glavnog dijela dokumenta.

Potreba za informacijskim dijelom u različitim vrstama programskih dokumenata određena je relevantnim GOST-ovima za te programske dokumente.

• Glavni dio. Sastav i struktura glavnog dijela programskog dokumenta utvrđeni su ESPD standardima za relevantne dokumente.
• Dio registracije promjena. U ovom se dijelu bilježi svaka promjena u programskom dokumentu u skladu sa zahtjevima GOST 19.603 - 78.

Vrsta programskog dokumenta. GOST 19.101 - 77

GOST 19.101-77 utvrđuje vrste programa i programskih dokumenata za računala, komplekse i sustave, bez obzira na njihovu svrhu i opseg.

GOST uspostavlja 2 vrste programa:

• Komponenta - program koji se smatra cjelinom, obavlja potpunu funkciju i koristi se samostalno ili kao dio kompleksa;
• Kompleks - program koji se sastoji od dvije ili više komponenti i (ili) kompleksa koji obavljaju međusobno povezane funkcije, a koristi se samostalno ili kao dio drugog kompleksa.

GOST također određuje vrste i sadržaj programskih dokumenata.

Određivanje programa i programskih dokumenata. GOST 19.103 - 77

GOST 19.103-77 utvrđuje strukturu označavanja programa i programskih dokumenata za računala, komplekse i sustave, bez obzira na njihovu svrhu i opseg primjene.

Jednostavno rečeno, ovaj GOST opisuje kakav bi trebao biti kod dokumenta obrasca A.V.HHHHH-HH XX XX-H, i što svako polje ove šifre znači.

Osnovni natpisi. GOST 19.104 - 78

GOST 19.104-78 utvrđuje obrasce, veličine, mjesto i postupak za popunjavanje glavnih natpisa lista odobrenja i naslovne stranice u programskim dokumentima predviđenim ESPD standardima, bez obzira na način njihove provedbe.

GOST sadrži primjere naslovne stranice i lista odobrenja, kao i opći oblik lista, podijeljen na polja. Možete vidjeti i primjer.

Zahtjevi za tiskane programske dokumente. GOST 19.106 - 78

GOST 19.106-78 utvrđuje pravila za izvršavanje programskih dokumenata za tiskanu metodu izvršenja.

Važno je napomenuti da se ovaj GOST ne odnosi na programski dokument "Programski tekst".

Materijali programskog dokumenta mora biti u sljedećem nizu:

• 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.);
  • aplikacije;
  • popis pojmova, popis kratica, popis slika, popis tablica, predmetno kazalo, popis referentnih dokumenata;
  • dio zapisivanja promjena:
  • promijeniti upisni list.

Anotacija označava izdanje programa i ukratko opisuje svrhu i sadržaj dokumenta. Ako se dokument sastoji od više dijelova, u napomeni se navodi ukupan broj dijelova. Sadržaj dokumenta nalazi se na zasebnoj (numeriranoj) stranici (stranicama) iza napomene, s naslovom "SADRŽAJ", nije numeriran kao odjeljak i uključen je u ukupan broj stranica dokumenta.

• Programski dokument se izvodi na jednoj strani lista, u dva intervala; dopušteno u jednom ili jednom i pol intervalu.
• Sažetak se stavlja na posebnu (numeriranu) stranicu s naslovom „SAŽETAK” i nije numeriran kao odjeljak.
• 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 malim slovima (osim prvog velikog).
• Rastavljanje riječi u naslovima nije dopušteno. Na kraju naslova nema točke.
• Udaljenost između naslova i sljedećeg teksta, kao i između naslova odjeljaka i pododjeljaka, treba biti jednaka:
  • pri izvršavanju dokumenta tipkanjem - dva intervala.
• Za odjeljke i pododjeljke, čiji je tekst napisan na istoj stranici s tekstom prethodnog odjeljka, razmak između posljednjeg reda teksta i sljedećeg naslova treba biti jednak:
  • pri izvršavanju dokumenta tipkanom metodom - tri tipkana intervala.
• Odjeljke, pododjeljke, paragrafe i podstavke treba numerirati arapskim brojevima s točkom.
• Unutar odjeljka moraju postojati kontinuirani brojevi za sve pododjeljke, paragrafe i podstavke uključene u ovaj odjeljak.
• Numeracija pododjeljaka uključuje broj odjeljka i redni broj pododjeljka uključenog u ovaj odjeljak, odvojene točkom (2.1; 3.1 itd.).
• Ako postoje odjeljci i pododjeljci, uz broj pododjeljka iza točke dodaje se redni broj točke i podtočke (3.1.1, 3.1.1.1 itd.).
• 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, na primjer: „ispisni uređaj2). " ili "papir5)".
• 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, ako ih u dokumentu ima više, numeriraju se arapskim brojevima kroz cijeli dokument.
• Formule u dokumentu, ako ih ima više, numeriraju se arapskim brojevima, a broj se stavlja na desnoj strani stranice, u zagradi na razini formule.
• Značenje simbola i numeričkih koeficijenata 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.
• U programskim dokumentima dopušteno je pozivanje na standarde (osim na standarde poduzeća), tehničke specifikacije i druge dokumente (na primjer, dokumente državnih nadzornih tijela, pravila i propise Državnog odbora za izgradnju SSSR-a). Pri upućivanju na norme i tehničke specifikacije navedena je njihova oznaka.
• Treba se pozvati na dokument u cjelini ili na njegove dijelove (uz naznaku i naziv dokumenta, broj i naziv odjeljka ili priloga). Kod ponavljanja referenci na odjeljak ili aplikaciju navodi se samo broj.
• 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.
• Nisu dopuštene kratice riječi u tekstu i natpisi ispod ilustracija.
• Ilustrirani materijal, tablice ili popratni tekst mogu se prikazati u obliku priloga.
• Svaka prijava mora započeti na novoj stranici s naznakom "DODATAK" u gornjem desnom kutu i imati tematski naslov koji se ispisuje simetrično u odnosu na tekst velikim slovima.

GOST sadrži uzorak lista koji označava polja, mjesta za numeriranje stranica i kod.

Moji najnoviji (2016.) predlošci.

Ovo je zanimljivo:

• Naredba 109/GS O odobrenju skupa pravila "SNiP 3.03.01-87 "Nosive i zaporne konstrukcije" Kupi Naredba 109/GS - službeni papirnati dokument s hologramom i plavim pečatima. više detalja Cijena za ovaj dokument još nije poznato Kliknite na gumb "Kupi" i naručite, a mi ćemo vam poslati [...]
• 1C:Enterprise 8 Standardna konfiguracija Računovodstvo za Kazahstan (osnovno), izdanje 2.0 Verzija 2.0.13 Novo u verziji 2.0.13.5 Ažuriranje reguliranih pokazatelja od 1. siječnja 2014. U skladu sa Zakonom Republike Kazahstan "O republičkom proračunu za 2014-2016" od 1. siječnja 2014. […]
• Bilježnica Ippolitova Nina Aleksandrovna u Odintsovu Recenzije bilježnice Ippolitove Nine Aleksandrovne Ovime slobodno, svojom voljom iu vlastitom interesu, dajem svoj pristanak tvrtki Media Solutions LLC, koja se nalazi na adresi Tyumen st. 50 godina VLKSM 19 - 76 (u daljnjem tekstu Operator) za automatizirane i […]
• 20 Javni bilježnici u Novorossiysku. Ovime slobodno, svojom slobodnom voljom iu vlastitom interesu, dajem svoj pristanak tvrtki Media Solutions LLC, koja se nalazi u Tyumen st. 50 godina VLKSM 19 - 76 (u daljnjem tekstu Operater) za automatiziranu i neautomatiziranu obradu svojih osobnih podataka u skladu s […]
• 13 Javni bilježnici u Naberezhnye Chelny Ovime slobodno, svojom slobodnom voljom iu vlastitom interesu, dajem svoj pristanak tvrtki Media Solutions LLC, koja se nalazi u Tyumen st. 50 godina VLKSM 19 - 76 (u daljnjem tekstu Operater) za automatiziranu i neautomatiziranu obradu svojih osobnih podataka u […]
• Blijeda zora obasjala sina tužioca, To staro groblje, A nad vlažnim grobom, Plakao je mladi lopov. A nad vlažnim grobom plakao je mladi lopov. Jadna moja majko, Zašto si tako rano otišla, Nisi vidjela svoj život, Našla si oca nitkova. Vaš život nije [...]
• Kazna za poravnanje Auto osiguranje Stambeni sporovi Zemljišni sporovi Upravno pravo Sudjelovanje u zajedničkoj izgradnji Obiteljski sporovi Građansko pravo, Građanski zakonik Ruske Federacije Zaštita prava potrošača Radni sporovi, mirovine Dom Vrste kazni: kompenzacija, […]
• Nalog (uputu) o stimulaciji radnika Nalog o stimulaciji (bonusima ili nagradama) radnika donosi čelnik organizacije, a nalog izdaju druge ovlaštene službene osobe. Voditelj organizacije također ima pravo podnijeti zahtjev za poticaje za zaposlenika […]

GOST 19.101-77

Grupa T55

MEĐUDRŽAVNI STANDARD

Jedinstveni sustav programske dokumentacije

VRSTE PROGRAMA I PROGRAMSKI DOKUMENTI

Jedinstveni sustav programske dokumentacije. Vrste programa i programski dokumenti

MKS 35.080

Datum uvođenja 1980-01-01

Odlukom Državnog odbora za standarde Vijeća ministara SSSR-a od 20. svibnja 1977. N 1268, datum uvođenja određen je na 01.01.80.

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


Ovom normom utvrđene su vrste programa i programskih dokumenata za računala, sklopove i sustave, bez obzira na njihovu namjenu i opseg.

Norma je u potpunosti u skladu sa ST SEV 1626-79.

(Promijenjeno izdanje, dopuna br. 1).

1. VRSTE PROGRAMA

1. VRSTE PROGRAMA

1.1. Program (prema GOST 19781-90) može se identificirati i koristiti samostalno i (ili) kao dio drugih programa.

1.2. Programi su podijeljeni u vrste prikazane u tablici 1.

stol 1

1.3. Dokumentacija razvijena za program može se koristiti za implementaciju i prijenos programa na medij za pohranu, kao i za izradu softverskog proizvoda.

1.2, 1.3. (Promijenjeno izdanje, dopuna br. 1).

2. VRSTE PROGRAMSKIH DOKUMENATA

2.1. Softverski dokumenti uključuju dokumente koji sadrže podatke potrebne za razvoj, proizvodnju, održavanje i rad programa.

2.2. Vrste programskih dokumenata i njihov sadržaj dani su u tablici 2.

tablica 2

2.3. Vrste pogonskih dokumenata i njihov sadržaj dani su u tablici 3.

Tablica 3

2.4. Ovisno o načinu implementacije i prirodi primjene, programski dokumenti dijele se na izvornike, duplikate i kopije (GOST 2.102-68), namijenjene razvoju, održavanju i radu programa.

2.5. Vrste programskih dokumenata razvijenih u različitim fazama i njihove šifre dane su u tablici 4.

Tablica 4

Legenda:

- dokument je obavezan;

- dokument je obvezan za komponente koje imaju samostalnu uporabu;

- potreba za izradom dokumenta utvrđuje se u fazi izrade i odobrenja tehničke specifikacije;

- - isprava nije sastavljena.

2.2-2.5. (Promijenjeno izdanje, dopuna br. 1).

2.6. Dopušteno je objedinjavanje pojedinih vrsta operativnih isprava (osim popisa operativnih isprava i obrasca). Potreba za kombiniranjem ovih dokumenata navedena je u tehničkim specifikacijama. Spojenom dokumentu dodjeljuje se naziv i oznaka jednog od spojenih dokumenata.

Spojeni dokumenti moraju navesti informacije koje moraju biti uključene u svaki dokument koji se spaja.

2.7. U fazi izrade i odobravanja tehničke specifikacije utvrđuje se potreba izrade tehničke specifikacije koja sadrži zahtjeve za izradu, kontrolu i prihvaćanje programa.

Tehničke specifikacije se izrađuju u fazi „Izvedbenog projekta“.

2.8. Potreba za izradom tehničkih specifikacija za komponente koje nisu namijenjene samostalnoj uporabi i komplekse uključene u druge komplekse utvrđuje se dogovorom s kupcem.

(Dodatno uvedena izmjena br. 1).



Tekst elektroničkog dokumenta
pripremio Kodeks JSC i provjerio prema:
službena objava
Jedinstveni softverski sustav
dokumentacija: sub. GOST. -
M.: Standardinform, 2010

Ovdje se želim usredotočiti samo na jednu temu s kojom se programer u domaćim poduzećima, posebno u istraživačkim institutima, mora baviti - skup ESPD standarda. Ne smatram se velikim stručnjakom za ESPD - postoje ljudi koji na tome rade desetljećima i sigurno će me ispraviti. Članak radije pokušava ocrtati obrise "karte puta" za one koji tek ulaze u zamah.

Standardi

1. međunarodni. Posebnost je da ga je usvojila međunarodna organizacija. Primjer takve organizacije je ISO (Međunarodna organizacija za standardizaciju). Primjer njegove norme: ISO 2382-12:1988 (Periferna oprema). Zajednički standardi ISO-a i Međunarodne elektrotehničke komisije (IEC, na ruskom - IEC) su široko rasprostranjeni: na primjer, ISO/IEC 12207:2008 (životni ciklus softvera);
2. Regionalni. Posebnost - usvojila regionalna komisija za standardizaciju. Na primjer, mnogi sovjetski GOST-ovi sada su regionalni standardi, jer usvojilo međudržavno vijeće, koje uključuje neke bivše sovjetske republike. Ovo vijeće također usvaja nove standarde - i oni također dobivaju oznaku GOST. Primjer: GOST 12.4.240-2013;
3. standardi javnih udruga; Na primjer, isti IEC: IEC 60255;
4. nacionalni standardi. Za Rusiju, početak takvih standarda je "GOST R". Mogu postojati tri vrste:
   1. točne kopije međunarodnih ili regionalnih. Označavaju se nerazlučivo od "samonapisanih" (nacionalnih, neovisno napisanih);
   2. preslike međunarodnih ili regionalnih s dodacima. Oni se označavaju dodavanjem šifre domaćeg standarda međunarodne šifre koja je uzeta kao osnova. Na primjer: GOST R ISO/IEC 12207;
   3. zapravo, nacionalnim standardima. Na primjer, GOST R 34.11-94.

Sustavi označavanja na svakoj razini i u svakoj organizaciji su različiti; svaki će se slučaj morati zasebno analizirati. Da biste brzo razumjeli "čiji" standard je pred vašim očima, možete koristiti varalicu.

GOST

Ako znate oznaku standarda, tada možete dobiti njegove kodove za KGS i OKS, na primjer, na ovoj pametnoj web stranici.
Dakle, vratimo se GOST oznakama. Mogu postojati dvije opcije:

1. standard se odnosi na niz standarda. U tom slučaju, nakon indeksa kategorije standarda (na primjer, GOST, GOST R ili GOST RV) nalazi se šifra serije, točka i oznaka standarda unutar serije. Pravila za označavanje standarda unutar serije utvrđuju se pravilima serije. Na primjer: GOST RV 15.201-2000, GOST R 22.8.0-99, GOST 19.101-77;
2. Standard ne pripada nizu standarda. Zatim iza indeksa kategorije jednostavno stoji redni broj standarda, crtica i godina usvajanja. Na primjer, GOST R 50628-2000.

ESPD

• GOST ESKD (jedinstveni sustav projektne dokumentacije, prefiks "2.");
• GOST ESTD (jedinstveni sustav tehnološke dokumentacije, prefiks "3.");
• GOST R, Sustav za razvoj i proizvodnju proizvoda, prefiks "15.";
• GOST RV, Naoružanje i vojna oprema. Sustav za razvoj i puštanje proizvoda u proizvodnju, prefiks “15.”;
• GOST, Sustav tehničke dokumentacije za automatizirane sustave upravljanja, prefiks "24.";
• GOST, Skup standarda za automatizirane sustave, prefiks "34.".

19.001-77. Opće odredbe

19.102-80. Sheme algoritama i programa. Pravila izvršenja.

19.003-80. Sheme algoritama i programa. Konvencionalni grafički simboli

19.004-80. Pojmovi i definicije.

19.005-85. P-sheme algoritama i programa

19.101-77. Vrste programa i programski dokumenti

19.102-77. Faze razvoja

19.102-77. Faze razvoja

19.103-77. Oznake programa i programskih dokumenata

19.104-78. Osnovni natpisi

• kao što je već spomenuto, poduzeće često ne želi otkriti podatke o programeru. Odvajanje LU i njegovo "stiskanje" omogućuje da se to učini (za razliku od ESKD-a, nema pečata na listovima dokumenata u ESPD-u; sve informacije su lokalizirane samo u LU);
• Brojna poduzeća koriste mješoviti protok dokumenata: izvorni dokumenti pohranjuju se elektronički u arhivu poduzeća, a dokumenti na njima (s originalnim potpisima) pohranjuju se u papirnatom obliku;

19.105-78. Opći zahtjevi za programske dokumente

19.106-78. Opći zahtjevi za tiskane programske dokumente

• „sadržaj dokumenta uključuje broj odjeljaka, pododjeljaka, klauzula i potklauzula koje imaju naslov” (klauzula 2.1.4). Ovo je izravna indikacija da potklauzula može imati naslov i biti uključena u sadržaj;
• "dopušteno je staviti tekst između naslova odjeljaka i pododjeljaka, između naslova pododjeljaka i paragrafa." Važno je napomenuti da nenumerirani tekst može biti samo između naslova i samo na gornje 2 razine.

• crvena crta;
• uvlačenje elementa strukture dokumenta iza odjeljka (pododjeljka, klauzule, potklauzule);
• element nabrajanja.

U tom slučaju, tekst koji se nalazi u sljedećem retku nakon uvučenog retka poravnat je s lijevom marginom. Često postoje pogreške kada uvlaka skače - crvena linija - jedna vrijednost, broj stavke - mi s različitim intervalom, u ugniježđenim uvlakama na popisima - to je općenito potrebno.

U sljedećim dijelovima planiram doći do kraja popisa ESPD standarda.

Ime:

Jedinstveni sustav programske dokumentacije.

Valjano

Datum predstavljanja:

Datum otkazivanja:

Zamijenjeno sa:

Tekst GOST 19.101-77 Jedinstveni sustav programske dokumentacije. Vrste programa i programski dokumenti

GOST 19.101-77

MEĐUDRŽAVNI STANDARD

OBJEDINJENI SOFTVERSKI DOKUMENTACIONI SUSTAV

VRSTE PROGRAMA I PROGRAMSKI DOKUMENTI

Službena objava

Standardinform

UDK 002:651.7/.78:006.354

Grupa T55

MEĐUDRŽAVNI STANDARD

Jedinstveni sustav programske dokumentacije

VRSTE PROGRAMA I PROGRAMSKI DOKUMENTI

Jedinstveni sustav programske dokumentacije.

Vrste programa i programski dokumenti

Dekretom Državnog odbora za standarde Vijeća ministara SSSR-a od 20. svibnja 1977. br. 1268 određen je datum uvođenja

Ovom normom utvrđene su vrste programa i programskih dokumenata za računala, sklopove i sustave, bez obzira na njihovu namjenu i opseg.

Norma je u potpunosti u skladu sa ST SEV 1626-79.

(Promijenjeno izdanje, dopuna br. 1).

1. VRSTE PROGRAMA

1.1. Program (prema GOST 19781-90) može se identificirati i koristiti samostalno i (ili) kao dio drugih programa.

1.2. Programi su podijeljeni u vrste prikazane u tablici. 1.

1.3. Dokumentacija razvijena za program može se koristiti za implementaciju i prijenos programa na medij za pohranu, kao i za izradu softverskog proizvoda.

1.2, 1.3. (Promijenjeno izdanje, dopuna br. 1).

2. VRSTE PROGRAMSKIH DOKUMENATA

2.1. Softverski dokumenti uključuju dokumente koji sadrže podatke potrebne za razvoj, proizvodnju, održavanje i rad programa.

2.2. Vrste programskih dokumenata i njihov sadržaj dani su u tablici. 2.

Službena objava ★

Umnožavanje je zabranjeno

) Izdavačka kuća za standarde, 1977. © STANDARDINFORM, 2010

Izdanje (siječanj 2010.) s dopunom br. 1, odobreno u lipnju 1981. (IUS 9-81).

tablica 2

2.3. Vrste pogonskih dokumenata i njihov sadržaj dani su u tablici. 3.

Tablica 3

operativni dokument

Popis operativnih dokumenata Obrazac

Opis primjene

Programer's Guide Operator's Guide

Jezik Opis Servisni priručnik

Popis operativnih dokumenata za program

Glavne karakteristike programa, cjelovitost i podaci o radu programa

Informacije o namjeni programa, opsegu primjene, korištenim metodama, klasi problema koje treba riješiti, ograničenjima za korištenje, minimalnoj konfiguraciji hardvera

Informacije za provjeru, osiguranje funkcioniranja i prilagodbu programa za uvjete konkretne aplikacije

Informacije za korištenje programa

Informacije koje osiguravaju postupak komunikacije između operatera i računalnog sustava tijekom izvođenja programa

Opis sintakse i semantike jezika

Informacije za korištenje testnih i dijagnostičkih programa pri servisiranju tehničke opreme

2.4. Ovisno o načinu implementacije i prirodi primjene, programski dokumenti dijele se na izvornike, duplikate i kopije (GOST 2.102-68), namijenjene razvoju, održavanju i radu programa.

2.5. Vrste programskih dokumenata razvijenih u različitim fazama i njihove šifre dane su u tablici. 4.

Tablica 4

Nastavak tablice 4

Legenda:

Dokument je obavezan;

C - obvezni dokument za komponente koje imaju samostalnu uporabu;

O - potreba za sastavljanjem dokumenta utvrđuje se u fazi razvoja i odobrenja tehničkih specifikacija;

Dokument nije sastavljen.

2.2-2.5. (Promijenjeno izdanje, dopuna br. 1).

2.6. Dopušteno je objedinjavanje pojedinih vrsta operativnih isprava (osim popisa operativnih isprava i obrasca). Potreba za kombiniranjem ovih dokumenata navedena je u tehničkim specifikacijama. Spojenom dokumentu dodjeljuje se naziv i oznaka jednog od spojenih dokumenata.

Spojeni dokumenti moraju navesti informacije koje moraju biti uključene u svaki dokument koji se spaja.

2.7. U fazi izrade i odobravanja tehničke specifikacije utvrđuje se potreba izrade tehničke specifikacije koja sadrži zahtjeve za izradu, kontrolu i prihvaćanje programa.

Tehničke specifikacije se izrađuju u fazi „Izvedbenog projekta“.

2.8. Potreba za izradom tehničkih specifikacija za komponente koje nisu namijenjene samostalnoj uporabi i komplekse uključene u druge komplekse utvrđuje se dogovorom s kupcem.

(Dodatno uvedena izmjena br. 1).

• GOST 19.001-77 Jedinstveni sustav programske dokumentacije. Opće odredbe
• GOST 19.005-85 Jedinstveni sustav programske dokumentacije. P-sheme algoritama i programa. Konvencionalne grafičke oznake i pravila izvođenja
• GOST 19.101-77 Jedinstveni sustav programske dokumentacije. Vrste programa i programski dokumenti
• GOST 19.102-77 Jedinstveni sustav programske dokumentacije. Faze razvoja
• GOST 19.103-77 Jedinstveni sustav programske dokumentacije. Oznake programa i programskih dokumenata
• GOST 19.104-78 Jedinstveni sustav programske dokumentacije. Osnovni natpisi
• GOST 19.105-78 Jedinstveni sustav programske dokumentacije. Opći zahtjevi za programske dokumente
• GOST 19.106-78 Jedinstveni sustav programske dokumentacije. Zahtjevi za tiskane programske dokumente
• GOST 19.201-78 Jedinstveni sustav programske dokumentacije. Tehnički zadatak. Zahtjevi za sadržaj i dizajn
• GOST 19.202-78 Jedinstveni sustav programske dokumentacije. Specifikacija. Zahtjevi za sadržaj i dizajn
• GOST 19.301-79 Jedinstveni sustav programske dokumentacije. Program i metodologija ispitivanja. Zahtjevi za sadržaj i dizajn
• GOST 19.401-78 Jedinstveni sustav programske dokumentacije. Tekst programa. Zahtjevi za sadržaj i dizajn
• GOST 19.402-78 Jedinstveni sustav programske dokumentacije. Opis programa
• GOST 19.403-79 Jedinstveni sustav programske dokumentacije. Popis originalnih nositelja
• GOST 19.404-79 Jedinstveni sustav programske dokumentacije. Objašnjenje. Zahtjevi za sadržaj i dizajn
• GOST 19.501-78 Jedinstveni sustav programske dokumentacije. Oblik. Zahtjevi za sadržaj i dizajn
• GOST 19.502-78 Jedinstveni sustav programske dokumentacije. Opis primjene. Zahtjevi za sadržaj i dizajn
• GOST 19.503-79 Jedinstveni sustav programske dokumentacije. Vodič za programera sustava. Zahtjevi za sadržaj i dizajn
• GOST 19.504-79 Jedinstveni sustav programske dokumentacije. Programerski vodič. Zahtjevi za sadržaj i dizajn
• GOST 19.505-79 Jedinstveni sustav programske dokumentacije. Priručnik za rukovanje. Zahtjevi za sadržaj i dizajn
• GOST 19.506-79 Jedinstveni sustav programske dokumentacije. Opis jezika. Zahtjevi za sadržaj i dizajn
• GOST 19.507-79 Jedinstveni sustav programske dokumentacije. Popis operativnih dokumenata
• GOST 19.508-79 Jedinstveni sustav programske dokumentacije. Priručnik za održavanje. Zahtjevi za sadržaj i dizajn
• GOST 19.601-78 Jedinstveni sustav programske dokumentacije. Opća pravila za umnožavanje, računovodstvo i skladištenje
• GOST 19.602-78 Jedinstveni sustav programske dokumentacije. Pravila za umnožavanje, evidentiranje i pohranjivanje tiskanih programskih dokumenata
• GOST 19.603-78 Jedinstveni sustav programske dokumentacije. Opća pravila za izmjene
• GOST 19.604-78 Jedinstveni sustav programske dokumentacije. Pravila za izmjene tiskanih programskih dokumenata
• GOST 28195-89 Procjena kvalitete softvera. Opće odredbe
• GOST 34.601-90 Informacijska tehnologija. Skup standarda za automatizirane sustave. Automatizirani sustavi. Faze stvaranja
• GOST 34.602-89 Informacijska tehnologija. Skup standarda za automatizirane sustave. Projektni zadatak za izradu automatiziranog sustava
• GOST R 56447-2015 Plin, plinski kondenzat, nafta i plin te naftna i plinsko kondenzatna polja. Softver za obradu i interpretaciju seizmičkih podataka. Osnovni funkcionalni i tehnički zahtjevi
• GOST R 56448-2015 Plin, plinski kondenzat, nafta i plin te naftna i plinsko kondenzatna polja. Softver za geološko modeliranje ležišta. Osnovni funkcionalni i tehnički zahtjevi
• GOST R 56450-2015 Plin, plinski kondenzat, nafta i plin te naftna i plinsko kondenzatna polja. Softver za hidrodinamičko modeliranje sustava za prikupljanje i obradu ugljikovodika. Osnovni funkcionalni i tehnički zahtjevi
• GOST R 55711-2013 Kompleks tehničkih sredstava automatizirane adaptivne HF (HF) dupleksne radio komunikacije. Algoritmi rada
• GOST R 56566-2015 Informacijske tehnologije. Evaluacija procesa. Dio 9. Profili ciljnih procesa
• GOST R 55692-2013 Elektronički moduli. Metode za sastavljanje i otklanjanje pogrešaka testnih programa za automatizirano upravljanje
• GOST R 56449-2015 Plin, plinski kondenzat, nafta i plin te naftna i plinsko kondenzatna polja. Softver za hidrodinamičko modeliranje polja. Osnovni funkcionalni i tehnički zahtjevi
• GOST R 56413-2015 Informacijske tehnologije. Europski ICT profili poslova
• GOST R ISO/IEC 15026-1-2016 Inženjering sustava i softvera. Jamstvo na sustave i softver. Dio 1. Pojmovi i vokabular
• GOST R ISO/IEC 15026-4-2016 Inženjering sustava i softvera. Jamstvo na sustave i softver. Dio 4. Jamstva životnog ciklusa
• GOST R 56920-2016 Inženjering sustava i softvera. Testiranje softvera. Dio 1. Pojmovi i definicije
• GOST R 56921-2016 Inženjering sustava i softvera. Testiranje softvera. Dio 2: Procesi testiranja
• GOST R ISO/IEC 26555-2016 Inženjering sustava i softvera. Alati i tehnike tehničkog upravljanja linijom proizvoda
• GOST R ISO/IEC 29155-1-2016 Inženjering sustava i softvera. Struktura komparativne analize učinkovitosti informatičkih projekata. Dio 1. Pojmovi i definicije
• GOST R 54360-2011 Sustavi upravljanja laboratorijskim informacijama (LIMS). Standardni vodič za provjeru valjanosti LIMS-a
• GOST R 54593-2011 Informacijske tehnologije. Besplatni softver. Opće odredbe
• GOST R ISO/IEC 12207-2010 Informacijska tehnologija. Inženjering sustava i softvera. Procesi životnog ciklusa softvera
• GOST R 53798-2010 Standardni vodič za sustave upravljanja laboratorijskim informacijama (LIMS)
• GOST R ISO/IEC 15504-1-2009 Informacijske tehnologije. Evaluacija procesa. 1. dio: Koncept i rječnik
• GOST R ISO/IEC 15504-2-2009 Informacijska tehnologija. Evaluacija procesa. 2. dio: Provođenje procjene
• GOST R ISO/IEC 15504-3-2009 Informacijska tehnologija. Evaluacija procesa. Dio 3: Vodič za ocjenjivanje
• GOST R 57098-2016 Inženjering sustava i softvera. Upravljanje životnim ciklusom. Vodič za opis procesa
• GOST R 57100-2016 Inženjering sustava i softvera. Opis arhitekture
• GOST R 57101-2016 Inženjering sustava i softvera. Procesi životnog ciklusa. Upravljanje projektima
• GOST R 57102-2016 Informacijske tehnologije. Inženjering sustava i softvera. Upravljanje životnim ciklusom. Dio 2: Smjernice za primjenu ISO/IEC 15288
• GOST R 57122-2016 Plin, plinski kondenzat, nafta i plin te naftna i plinsko kondenzatna polja. Softver za projektiranje izgradnje bunara. Osnovni funkcionalni i tehnički zahtjevi
• GOST R 57193-2016 Inženjering sustava i softvera. Procesi životnog ciklusa sustava
• GOST R ISO/IEC 15504-5-2016 Informacijske tehnologije. Evaluacija procesa. Dio 5: Ogledni model za procjenu procesa životnog ciklusa softvera
• GOST 34009-2016 Sredstva i sustavi za upravljanje željezničkim vučnim voznim parkom. Softverski zahtjevi
• GOST R 57318-2016 Sustavi industrijske automatizacije i integracija. Primjena i upravljanje procesima sistemskog inženjerstva
• GOST R ISO/IEC 25001-2017 Informacijska tehnologija. Inženjering sustava i softvera. Zahtjevi i evaluacija kvalitete sustava i softvera (SQuaRE). Planiranje i upravljanje
• GOST R ISO/IEC 33004-2017 Informacijske tehnologije. Evaluacija procesa. Zahtjevi za referentne modele procesa, modele procjene procesa i modele zrelosti
• GOST R ISO/IEC 15414-2017 Informacijske tehnologije. Otvorena distribuirana obrada. Referentni model. Jezik opisa poduzeća
• GOST IEC 60848-2016 GRAFCET specifikacijski jezik za dijagrame sekvencijalnih funkcija
• GOST R ISO/IEC 25051-2017 Informacijske tehnologije. Inženjering sustava i softvera. Zahtjevi i evaluacija kvalitete sustava i softvera (SQuaRE). Zahtjevi za kvalitetu i upute za testiranje gotovog softverskog proizvoda (RUSP).
• GOST R ISO/IEC 33001-2017 Informacijske tehnologije. Evaluacija procesa. Pojmovi i terminologija
• GOST R ISO/IEC 33002-2017 Informacijske tehnologije. Evaluacija procesa. Zahtjevi za provođenje procjene procesa
• GOST R ISO/IEC 33003-2017 Informacijske tehnologije. Evaluacija procesa. Zahtjevi za procesne mjerne sustave
• GOST R ISO/IEC 33020-2017 Informacijske tehnologije. Evaluacija procesa. Sustav mjerenja procesa za ocjenu sposobnosti procesa
• GOST R 57640-2017 Informacijske tehnologije. Referentni model procesa (RPM) za upravljanje informacijskom sigurnošću
• GOST R ISO/IEC 30121-2017 Informacijske tehnologije. Koncept upravljanja rizicima povezanim s forenzičkim ispitivanjem dokaza prezentiranih u digitalnom obliku
• GOST R 58041-2017 Plin, plinski kondenzat, nafta i plin te naftna i plinsko kondenzatna polja. Sustav softverskih standarda za rješavanje problema traženja, istraživanja i razvoja ležišta. Osnovne odredbe i tehnički zahtjevi
• GOST R 58042-2017 Plin, plinski kondenzat, nafta i plin te naftna i plinsko kondenzatna polja. Osnovni zahtjevi za početne podatke programskih sustava za rješavanje problema traženja, istraživanja i razvoja polja
• GOST R ISO/IEC 10746-1-2004 Informacijska tehnologija. Otvorena distribuirana obrada. Osnovni model. Dio 1. Osnovne odredbe
• GOST R ISO/IEC 10746-4-2004 Informacijska tehnologija. Otvorena distribuirana obrada. Osnovni model. Dio 4. Arhitektonska semantika
• GOST R ISO/IEC 12119-2000 Informacijska tehnologija. Programski paketi. Zahtjevi kvalitete i ispitivanja
• GOST R ISO/IEC 12207-99 Informacijska tehnologija. Procesi životnog ciklusa softvera
• GOST R ISO/IEC 14764-2002 Informacijska tehnologija. Programska podrška

Izrada programske dokumentacije

Tehničke specifikacije za razvoj softverskog proizvoda

3.2. Opis programa

3.3. Tekst programa

Program i metodologija ispitivanja

3.5. Zahtjevi za tiskane programske dokumente

Primjena. Obrazac tehničke specifikacije za razvoj programskog proizvoda (proizvoda, modela)

Uvod. Opće informacije o Jedinstvenom sustavu programske dokumentacije (USPD).

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 norme definiraju opće odredbe i temeljne standarde, pravila za izvođenje razvojne dokumentacije, pravila za izvođenje proizvodne dokumentacije, pravila za izvođenje popratne dokumentacije, pravila za izvođenje operativne dokumentacije, pravila za promet programske dokumentacije i druge standarde. .

ESPD uključuje:

· temeljne i organizacijsko-metodološke standarde;

· norme kojima se definiraju oblici i sadržaj programskih dokumenata koji se koriste u obradi podataka;

· standardi koji osiguravaju automatizaciju izrade programskih dokumenata.

Popis ESPD dokumenata 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. Priručnik za 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.

Ostali standardi u području dokumentiranja softverskih sustava (PS) uključuju:

GOST 34.602-89 Informacijska tehnologija. Skup standarda za automatizirane sustave. Projektni zadatak za izradu automatiziranog sustava.

GOST 34.601-90 Informacijska tehnologija. Skup standarda za automatizirane sustave. Automatizirani sustav. Faze stvaranja.

GOST R ISO/IEC TO 12182-2002 Informacijska tehnologija. Klasifikacija softvera.

GOST R ISO/IEC 12207-99 Informacijska tehnologija. Procesi životnog ciklusa softvera.

GOST R ISO/IEC 14764-2002 Informacijska tehnologija. Održavanje softvera.

GOST R ISO/IEC 15026-2002 Informacijska tehnologija. Razine integriteta sustava i softvera.

GOST R ISO/IEC TO 15271-2002 Informacijska tehnologija. Smjernice za korištenje GOST R ISO/IEC 12207-99.

GOST R ISO/IEC 15910-2002 Informacijska tehnologija. Proces izrade korisničke dokumentacije softvera.

Međunarodni standardi ISO/IEC:

ISO/IEC 12207:2008 Inženjering sustava i softvera – Procesi životnog ciklusa softvera.

ISO/IEC 15288:2008 Inženjering sustava i softvera – Procesi životnog ciklusa sustava.

IEEE 830-1998 Preporučena praksa za specifikacije softverskih zahtjeva.

IEEE 1233-1998 Vodič za razvoj specifikacija zahtjeva sustava.

IEEE 1016-1998 Preporučena praksa za opise dizajna softvera.

ISO/IEC 42010 IEEE Std 1471-2000 Inženjering sustava i softvera – Preporučena praksa za opis arhitekture softverski intenzivnih sustava.

ISO 9001:2000 Sustavi upravljanja kvalitetom – Zahtjevi.

ISO/IEC 90003:2004 Softversko inženjerstvo – Smjernice za primjenu ISO 9001:2000 na računalni softver.

ISO/IEC TR 90005:2008 Programsko inženjerstvo – Smjernice za primjenu ISO 9001:2000 na procese životnog ciklusa sustava.

ISO/IEC 9126-1:2001 Programsko inženjerstvo – Kvaliteta proizvoda – 1. dio: Model kvalitete.

ISO/IEC 9126-2:2003 Programsko inženjerstvo – Kvaliteta proizvoda – 2. dio: Vanjska metrika.

ISO/IEC 9126-3:2003 Programsko inženjerstvo – Kvaliteta proizvoda – Dio 3: Interna metrika.

ISO/IEC 9126-4:2004 Softversko inženjerstvo – Kvaliteta proizvoda – 4. dio: Mjerila kvalitete u uporabi.

ISO/IEC 25051:2006 Softversko inženjerstvo – Zahtjevi za kvalitetu softverskog proizvoda i evaluacija (SQuaRE) – Zahtjevi za kvalitetu komercijalnog gotovog (COTS) softverskog proizvoda i upute za testiranje.

IEEE 829-1998 standard za dokumentaciju o testiranju softvera.

IEEE 829-2008 Standard za dokumentaciju o testiranju softvera i sustava.

IEEE 1008-1987 (R1993, R2002) Standard za testiranje softverskih jedinica.

ISO/IEC 14598-1:1999 Informacijska tehnologija – Ocjenjivanje softverskog proizvoda – 1. dio: Opći pregled.

ISO/IEC 14598-2:2000 Programsko inženjerstvo – Evaluacija proizvoda – 2. dio: Planiranje i upravljanje.

ISO/IEC 14598-3:2000 Programsko inženjerstvo – Evaluacija proizvoda – 3. dio: Proces za programere.

ISO/IEC 14598-4:1999 Programsko inženjerstvo – Evaluacija proizvoda – Dio 4: Proces za stjecatelje.

ISO/IEC 14598-5:1998 Informacijska tehnologija – Vrednovanje softverskog proizvoda – 5. dio: Proces za evaluatore.

ISO/IEC 14598-6:2001 Programsko inženjerstvo – Evaluacija proizvoda – Dio 6: Dokumentacija modula evaluacije.

Kao što vidite, glavni dio skupa domaćih ESPD standarda razvijen je 70-ih i 80-ih godina. Neki od tih standarda su moralno zastarjeli, a nisu bez i određenih nedostataka: prvo, ne odražavaju neke suvremene trendove u oblikovanju programa i programske dokumentacije, a drugo, u tim standardima postoji višestruko umnožavanje fragmenata programske dokumentacije. Ipak, u nedostatku boljeg, moramo se fokusirati na njih.

ESPD standardi pojednostavljuju proces dokumentiranja softverskih sustava. Istodobno, ESPD standardi, na temelju zahtjeva Naručitelja, dopuštaju neke promjene u setu dokumentacije za programske sustave, kako u strukturi tako iu sadržaju utvrđenih tipova softverskih dokumenata.

Osim toga, gore navedeni standardi su savjetodavne prirode i postaju obvezni na ugovornoj osnovi - tj. kada se na njih poziva u ugovoru za razvoj ili isporuku softvera.

Pri razmatranju pravila za sastavljanje programske dokumentacije potrebno je imati na umu da je preporučljivo svaki dokument prethoditi nekim uvodom.

Uvod sadrži općenite riječi o relevantnosti, nužnosti i značaju itd. razvijen softverski proizvod.