jedan sustav programska dokumentacija. Sheme algoritama i programa. Pravila izvršenja.
Jedinstveni sustav programske dokumentacije. Sheme algoritama i programa. Konvencionalni grafički simboli
Jedinstveni sustav programske dokumentacije. Pojmovi i definicije.
Jedinstveni sustav programske dokumentacije. P-sheme algoritama i programa.
Jedinstveni sustav programske dokumentacije. Vrste programa i programski dokumenti.
Jedinstveni sustav programske dokumentacije. Faze razvoja.
Jedinstveni sustav programske dokumentacije. Oznake programa i programskih dokumenata.
Jedinstveni sustav programske dokumentacije. Osnovni natpisi.
Jedinstveni sustav programske dokumentacije. Opći zahtjevi na programske dokumente.
Jedinstveni sustav programske dokumentacije. Zahtjevi za tiskane programske dokumente.
Jedinstveni sustav programske dokumentacije. Tehnički zadatak. Zahtjevi za sadržaj i dizajn.
Jedinstveni sustav programske dokumentacije. Specifikacija. Zahtjevi za sadržaj i dizajn.
Jedinstveni sustav programske dokumentacije. Program i metodologija ispitivanja. Zahtjevi za sadržaj i dizajn.
Jedinstveni sustav programske dokumentacije. Tekst programa. Zahtjevi za sadržaj i dizajn.
Jedinstveni sustav programske dokumentacije. Opis programa.
Jedinstveni sustav programske dokumentacije. Popis originalnih nositelja.
Jedinstveni sustav programske dokumentacije. Objašnjenje. Zahtjevi za sadržaj i dizajn.
Jedinstveni sustav programske dokumentacije. Oblik. Zahtjevi za sadržaj i dizajn.
Jedinstveni sustav programske dokumentacije. Opći opis. Zahtjevi za izradu i dizajn.
Jedinstveni sustav programske dokumentacije. Vodič za programera sustava. Zahtjevi za sadržaj i dizajn.
Jedinstveni sustav programske dokumentacije. Programerski vodič. Zahtjevi za sadržaj i dizajn.
Jedinstveni sustav programske dokumentacije. Priručnik za rukovanje. Zahtjevi za sadržaj i dizajn.
Jedinstveni sustav programske dokumentacije. Opis jezika. Zahtjevi za sadržaj i dizajn.
Jedinstveni sustav programske dokumentacije. Popis operativnih dokumenata.
Jedinstveni sustav programske dokumentacije. Vodič održavanje. Zahtjevi za sadržaj i dizajn.
Jedinstveni sustav programske dokumentacije. Opća pravila umnožavanje, računovodstvo i skladištenje.
Jedinstveni sustav programske dokumentacije. Pravila za umnožavanje, evidentiranje i pohranjivanje tiskanih programskih dokumenata.
Jedinstveni sustav programske dokumentacije. Opća pravila za izmjene.
Jedinstveni sustav programske dokumentacije. Pravila za izmjene programskih dokumenata izrađenih u tisku.
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
Vrsta programa | Definicija |
komponenta | Program koji se promatra kao cjelina, 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 |
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
Vrsta programskog dokumenta | |
Specifikacija | Sastav programa i njegove dokumentacije |
Popis poduzeća koja pohranjuju izvorne programske dokumente |
|
Tekst programa | Snimanje programa uz potrebne komentare |
Opis programa | Podaci o logičkoj strukturi i radu programa |
Zahtjevi koji se provjeravaju pri testiranju programa te postupak i metode njihove kontrole |
|
Tehnički zadatak | Svrha i opseg programa, tehnička izvedivost i posebni zahtjevi za program, potrebne faze i rokovi razvoja, vrste ispitivanja |
Objašnjenje | Dijagram algoritma, Opći opis algoritam i (ili) funkcioniranje programa, kao i obrazloženje donesenih tehničkih i tehničko-ekonomskih odluka |
Operativni dokumenti | Informacije koje osiguravaju funkcioniranje i rad programa |
2.3. Vrste pogonskih dokumenata i njihov sadržaj dani su u tablici 3.
Tablica 3
Vrsta operativnog dokumenta | |
Popis operativnih dokumenata za program |
|
Oblik | Glavne karakteristike programa, cjelovitost i podaci o radu programa |
Opis primjene | Informacije o namjeni programa, opsegu, korištenim metodama, klasi riješenih problema, ograničenjima za korištenje, minimalnoj konfiguraciji tehnička sredstva |
Informacije za provjeru, osiguranje funkcioniranja i prilagodbu programa za uvjete konkretne aplikacije |
|
Programerski vodič | Informacije za korištenje programa |
Priručnik za rukovanje | Informacije koje osiguravaju postupak komunikacije između operatera i računalnog sustava tijekom izvođenja programa |
Opis jezika | 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
Kodirati | Vrsta dokumenta | Faze razvoja |
|||
Idejni projekt | Tehnički projekt | Radni nacrt |
|||
komponenta | kompleks |
||||
Specifikacija | |||||
Popis originalnih nositelja | |||||
Tekst programa | |||||
Opis programa | |||||
Popis operativnih dokumenata | |||||
Oblik | |||||
Opis primjene | |||||
Vodič za programera sustava | |||||
Programerski vodič | |||||
Priručnik za rukovanje | |||||
Opis jezika | |||||
Priručnik za održavanje | |||||
Program i metodologija ispitivanja | |||||
Objašnjenje | |||||
Ostali dokumenti | |||||
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
Jedno vrijeme, dok sam tek počinjao raditi kao programer, često sam čuo "molim vas da napišete dokumentaciju za svoj program." Sve sam iskreno opisao, dao šefu, nakon čega je počela seansa crne magije. Nakon nekog vremena nazvao me šef i počeo mrmljati neartikulirane zvukove, gužvati ispis mog “najboljeg” teksta u rukama, bježati očima. Općenito značenje njegovog mukanja bilo je da je ispalo "pogrešno", "pogrešno" i "pogledaj što drugi rade". Budući da je bilo nemoguće izvući bilo koji drugi odgovor od njega, otišao sam u "druge" po primjere dokumenata. U pravilu su to bili veseli dečki, čiji su govori značili da "evo primjera", "općenito, prema GOST-u" i "sve ovo nikome ne treba". Tako sam prvi put saznao da programer može doći u kontakt sa strašnim GOST standardima.
Nevjerojatno je da među mnogim desecima mojih kolega, vrlo inteligentnih programera, nije bilo nikoga tko bi drugačije tretirao GOST-ove. Čak i ono malo ljudi koji su ih poznavali i, činilo se, znali čak i sastavljati dokumente, odnosili su se prema njima s prezirom i formalnošću. Situacija u kojoj čak ni ljudi odgovorni za upravljanje razvojem ne razumiju zašto su potrebni GOST-ovi i kako će se oni primjenjivati događa se u mnogim poduzećima cijelo vrijeme. Da, bilo je tvrtki koje su razumjele kako se "Opis programa" razlikuje od "Opisa aplikacije", ali bila je jasna manjina njih. Na Internetu prevladava stajalište da su GOST-ovi za programere očiti rudiment i potrebni su samo ako im se "savijaju". Nacrt dizajna smatra se "relativno pravednim načinom oduzimanja viška novčanica od kupca." Morao sam to proniknuti i razumjeti relativno nedavno - u procesu razvoja sustava upravljanja zahtjevima prilagođenog domaćim specifičnostima. Dokumentacija koja, naravno, mora biti izrađena "prema GOST-u".
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
Pogledajmo ukratko koji standardi postoje (s fokusom na IT područje).- 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 PO);
- 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;
- standardi javnih udruga; Na primjer, isti IEC: IEC 60255;
- nacionalni standardi. Za Rusiju, početak takvih standarda je "GOST R". Mogu postojati tri vrste:
- točne kopije međunarodnih ili regionalnih. Označavaju se nerazlučivo od "samonapisanih" (nacionalnih, neovisno napisanih);
- 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;
- zapravo, nacionalnim standardima. Na primjer, GOST R 34.11-94.
Notacijski sustavi na svakoj razini iu 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
Dakle: norme su međunarodne, međudržavne (regionalne) i nacionalne. GOST je, kako saznajemo, regionalni standard. GOST-ovi imaju prilično zbunjujući, po mom mišljenju, sustav označavanja. U potpunosti je navedeno u GOST R 1.5-2004, dat ću minimum za navigaciju. Prvo, potrebno je razlikovati oznaku GOST od njegove klasifikacije. Oznaka je, grubo rečeno, jedinstveni identifikator standard Kod klasifikatora je pomoćni kod koji pomaže pronaći standard ili odrediti kojem području znanja pripada. Klasifikatora može biti mnogo, uglavnom se koriste dva: KGS (klasifikator državnih standarda) i njegov nasljednik OKS (sveruski klasifikator standarda). Na primjer: "GOST R 50628-2000" je oznaka standarda. Iz oznake je samo jasno da je usvojen 2000. godine. Ima OKS kod “33.100;35.160”: tj. “33” - odjeljak “Telekomunikacije, audio, video”, “100” - pododjeljak “elektromagnetska kompatibilnost”. Međutim, također je uključen u granu klasifikatora 35.160. “35” - “ Informacijska tehnologija. Uredski strojevi”, “160” - “Mikroprocesorski sustavi...”. A prema KGS-u ima šifru "E02", što znači "E" - "Elektronička tehnika, radioelektronika i komunikacije", "0" - "Opća pravila i propisi za elektroničku tehniku, radioelektroniku i komunikacije" itd.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:
- 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;
- 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
ESPD je jedna od ovih GOST serija, broj 19. To je. svi standardi koji se odnose na ESPD počinju s prefiksom "19.": na primjer, GOST 19.106-78. Skraćuje "Jedinstveni sustav programske dokumentacije". Postoje i druge serije:- GOST ESKD ( jedan sustav projektna dokumentacija, 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čka dokumentacija na ACS, prefiks “24.”;
- GOST, Skup standarda za automatizirani sustavi, prefiks “34.”.
19.001-77. Opće odredbe
Opisuje pravila za dodjeljivanje oznaka standardima u seriji ESPD. Nije potrebno u praktičnom životu.19.102-80. Sheme algoritama i programa. Pravila izvršenja.
Opisuje pravila za konstruiranje i projektiranje algoritama. Koristi notaciju iz 19.103. U mojoj praksi, jedini put kada je to bilo potrebno bilo je kada je certifikacijski laboratorij inzistirao na formalnoj osnovi da je potreban dijagram algoritma. S moje točke gledišta, klasični dijagrami toka su stvar prošlosti, a jedino mjesto gdje ostaju koliko-toliko prikladni je ako, prilikom izlaganja, autor želi fokusirati pažnju čitatelja na algoritam.19.003-80. Sheme algoritama i programa. Konvencionalni grafički simboli
S obzirom grafički simboli važeće vrste elemenata dijagrama toka. Obavezno ako se koriste dijagrami toka.19.004-80. Pojmovi i definicije.
Oskudan pojmovnik. Najzanimljivije je to što sadrži formalne definicije programskih i operativnih dokumenata.19.005-85. P-sheme algoritama i programa
Gotovo zaboravljeni jezik. Svojedobno su se P-sheme naširoko koristile u raketnoj i svemirskoj industriji, postavši de facto standard za pisanje programa za kontrolu lansiranja i simulaciju lansiranja. Međutim, sada je ovaj jezik potpuno zaboravljen. U svom radu nikada se nisam susreo s P-shemama. Iako, u usporedbi s blok dijagramima, imaju primjetne prednosti: kompaktni su, prikladni za vizualizaciju nelinearnih algoritama (primjerice klasa u C++) ili struktura podataka. Istodobno, na internetu nema praktički nikakvih informacija o njima: ovo i ovo mjesto smatram korisnim. U svakom slučaju, kad bih sada morao umetnuti dijagram algoritma u softversku dokumentaciju, izabrao bih P-dijagrame radije nego dijagrame toka.19.101-77. Vrste programa i programski dokumenti
Sadrži tablicu podudarnosti vrste dokumenta i njegove šifre, kao i podjelu vrsta dokumenata na operativne i programske. Uvodi se pojam kompleksa i komponente. Nema ništa drugo korisno.19.102-77. Faze razvoja
Važna i neophodna norma koja opisuje vrste dokumenata i daje kodove za vrste programskih dokumenata. Ovaj standard (zajedno s 19.103-77) jedan je od ključeva za "razotkrivanje" oznaka dokumenata poput ABVG.10473-01 32 01-1.Norma uvodi pojam kompleksa i komponente (određeni broj poduzeća dodaje i treću vrstu - set, kada su u pitanju nepovezani softverski elementi), te je dana podjela: koji su dokumenti operativni, a koji nisu.
Trebali biste biti oprezni s tablicom 4, koja pokazuje koji se dokument izvršava u kojoj fazi razvoja. Faze razvoja obično su regulirane standardima za provedbu projektiranja i razvoja, a tamo je također naznačeno koji se dokumenti moraju prezentirati kupcu u svakoj fazi.
19.102-77. Faze razvoja
Koliko se ja sjećam, ovaj se standard nikada nije koristio: tko radi što u kojoj fazi i o čemu izvještava zapisano je u tehničkim specifikacijama ili se upućuje na GOST-ove, gdje je to jasnije navedeno (na primjer, GOST RV 15.203 ). U isto vrijeme, za početnike, sadrži prilično sažet pregled rada na glavnim fazama OKP-a.19.103-77. Oznake programa i programskih dokumenata
Potreban je uglavnom kako bismo naučili čitati simbole dokumenata sličnih gore navedenom. Međutim, razumijevanje notacije je korisno kada morate ići dalje standardni rad: na primjer, zapamtite da su dokumenti s kodovima nakon 90 korisnički definirani, tj. bilo koji. U mojoj praksi objavili smo dokument 93, koji smo nazvali “Izjava o programskoj dokumentaciji”, dokument 96 - “Upute za sastavljanje”.Uobičajeni izraz "izvršna opcija" nedostaje u ESPD-u i zamijenjen je "revizijskim brojem". S jedne strane, to nije sasvim točno: broj revizije bio je namijenjen praćenju evolucije programa: prvo se izdaje prvo izdanje, a zatim, na primjer, nakon revizije, drugo. Ali u praksi, kada trebate izdati verziju softvera za nekoliko operativni sustavi(softver na više platformi), nema drugog izbora. Točnije, postoji, ali je netočna: dodijelite verziji za svaki operacijski sustav svoju oznaku - i stavite u arhivu nekoliko diskova s izvornim kodovima (prema broju operativnih sustava), razvijte (zapravo kopirajte) cijeli komplet dokumentacije itd.... To je. čista glupa i zbunjujuća aktivnost. Rješenje u obliku dodjele broja verzije svakom operacijskom sustavu omogućuje da neki dokumenti budu zajednički.
ESPD koristi oznaku izvornog koda programa i rezultata asemblera kao "dokumenata", što zbunjuje mnoge programere. Dokument “tekst programa”, prema 19.101-77, ima oznaku 12. Dalje je prihvaćeno da je izvorni kod označen kao 12 01 - tj. 01 (prvi) dokument tipa 12, a binarni - poput 12 02 - tj. drugi dokument tipa 12. U nekim slučajevima potrebni su dodatni alati za izradu programa - kompajleri, generatori instalatera itd. Oni. programe koji nisu uključeni u isporuku, ali su potrebni za montažu. Rješenje bi moglo biti označiti ih kao 12 03 - tj. treći dokument tipa 12.
19.104-78. Osnovni natpisi
Opisuje dva lista dokumenta - list odobrenja (LA) i Naslovnica. List odobrenja u ESPD-u sadrži potpise i tijela koja su odobrila dokument i razvijača, normativnih inspektora, predstavnika za prihvaćanje itd. Oni. sadrži dosta osjetljivih informacija za poduzeće. Stoga standard pretpostavlja da LU ostaje u razvojnom poduzeću i šalje se samo po posebnim uputama. Još jednom, LU nije dio dokumenta, već je, takoreći, zaseban dokument i uključen je u specifikaciju kao zaseban redak.U početku zbunjujuća neobičnost u odvajanju LU od samog dokumenta ima vrlo dobre razloge:
- 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: originalni dokumenti pohranjuju se u u elektroničkom obliku u arhivi poduzeća, a registarske pločice na njima (s originalnim potpisima) - na papiru;
Također treba imati na umu da LU nije numeriran, a prva stranica je naslovna stranica, a prva stranica na koju se stavlja broj je uz naslovnu stranicu. Ali ako postoji više od jedne LU (to se događa ako svi potpisi ne stanu na list), tada se LU numeriraju zasebno.
19.105-78. Opći zahtjevi za programske dokumente
Uvodi se opća struktura dokumenta, bez obzira na način njegova izvršenja. Oni. Još 1978. godine standardom je propisano da dokument ne mora nužno biti papirnati. Konkretno, uvodi se pojam sadržaja za potpuno elektronički dokumenti. Za izvođenje na papiru, uobičajeno u to vrijeme, usvojen je GOST 19.106-78.Trenutno se rijetko treba pozivati na ovaj standard: osim ako se zaboravi redoslijed glavnih dijelova dokumenta.
19.106-78. Opći zahtjevi za tiskane programske dokumente
Najopsežniji standard iz ESPD-a, odmah iza opisa R-shema. To je glavni radni standard pri izradi dokumentacije. Uvodi pravila za oblikovanje teksta, elemente strukture dokumenta, slike, formule itd. Međutim, za razliku od odgovarajućeg 2.106 iz ESKD-a, 19.106 je znatno manje detaljan, što dovodi do brojnih nejasnoća.Prvo, standard zapravo ne definira prored i količinu okomitog razmaka između naslova. On uvodi tri pravila za određivanje proreda: za tipkani tekst, strojni i tipografski.
Strojno pismo je tekst ispisan pisaćom mašinom. Pomak sljedećeg retka u odnosu na prethodni izvršen je automatski tijekom takozvanog "povratka karijete" - prijelaza na ispis sljedećeg retka, proizvedenog pomicanjem posebne poluge. Tipično, razmak se mogao ručno podesiti okretanjem osovine za uvlačenje papira i imao je "postavku" koja vam je omogućavala postavljanje veličine razmaka - jednostruki ili dvostruki.
Tip stroja je najvjerojatnije tiskani tekst. Ali za njega postoji samo naznaka da rezultat mora biti prikladan za mikrofilmovanje. Ovo je implicitna referenca na 13.1.002-2003, koja, nažalost, postavlja prored (i, usput, minimalnu visinu fonta) samo za rukom pisane dokumente (klauzula 4.2.5).
Tipografski - tekst otipkan u tiskari. S obzirom na godinu donošenja standarda, najvjerojatnije je riječ
[visoki tisak, gdje je prored određen korištenom vrstom. Nisam stručnjak za tipografiju i trenutno postoji vrlo malo informacija o metodama slaganja.
Koji interval koristiti na kraju često određuju lokalni propisi ili servisne postaje. Tipične vrijednosti su jedan i pol prored i veličina slova 14.
Način na koji je dokument strukturiran često postavlja mnoga pitanja. 19.106 smatra da je cijeli dokument podijeljen na odjeljke, pododjeljke, paragrafe i podstavke. Svi oni (osim odjeljaka i pododjeljaka) mogu i ne moraju imati naslov. pri čemu:
- „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.
Ovaj standard ima brojne "rupe" i nedosljednosti. Na primjer, kaže se: „ilustracije, ako su u ovaj dokument više od jednog, numerirani su arapskim brojevima u cijelom dokumentu. “Ali ako postoji samo jedna ilustracija, onda ona nije numerirana, i kako se onda možete pozivati na nju? Isto vrijedi i za stolove. Za fusnote, GOST ne označava način njihovog numeriranja - unutar cijelog dokumenta ili unutar stranice.
Stolovi. Sam dokument sadrži referencu na GOST 1.5.68. Sudeći po prvoj epizodi, lako je zaključiti da se radi o standardu za razvoj standarda. Kakve on veze ima s tim nije jasno. U smislu, odgovara pravilima za izradu tablica u ESKD-u, uz manje iznimke. Ovaj standard je poništen i zamijenjen, kroz nekoliko iteracija, do 1.5-2012, u kojem su pravila dizajna tablice... jednostavno nestala. Još 1.5-2002 su bili tu, ali već 1.5-2004 su nestali. U stvaran život Tablice izrađujemo prema ESKD-u.
Prijave. Norma ne navodi jesu li slike, formule i tablice iz dodataka uključene u opći popis. Isto tako, nije rečeno treba li sadržaj otkriti strukturu prijave ako sadrži vlastite odjeljke, paragrafe itd. U našoj praksi ne otkrivamo unutrašnjost aplikacija.
Na kraju treba reći nešto o uvlačenju. Uvlačenje odlomka od 5 znakova uobičajeno je za:
- 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 artikla - 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.
ESPD – odnosi se na složene sustave općih tehničkih standarda
ESPD je sustav međudržavnih standarda zemalja ZND-a koji djeluju u Ruskoj Federaciji, na temelju međudržavnog sporazuma o normizaciji. ESPD standardi pokrivaju onaj dio dokumentacije koji nastaje tijekom razvoja softvera i uglavnom je povezan s dokumentiranjem funkcionalnih karakteristika softvera. ESPD standardi su savjetodavne prirode
ESPD je skup državnih standarda koji uspostavljaju međusobno povezana pravila za razvoj, izvođenje i promet programa i programske dokumentacije
ESPD standardi uspostavljaju zahtjeve koji uređuju razvoj, podršku, proizvodnju i rad programa, čime se osigurava mogućnost:
1. Unifikacija programskih proizvoda za međusobnu razmjenu programa i korištenje prethodno razvijenih programa u novim razvojima
2. Smanjenje intenziteta rada i povećanje učinkovitosti razvoja, održavanja, proizvodnje i rada programskih proizvoda
3. Automatizacija, izrada i pohrana programske dokumentacije
Održavanje programa uključuje analizu funkcioniranja, razvoja i poboljšanja programa, kao i izmjene istog radi otklanjanja grešaka
Pravila i propisi utvrđeni u ESPD standardima primjenjuju se na programe i softversku dokumentaciju za subtraktivne strojeve, komplekse i sustave, bez obzira na njihovu svrhu i opseg primjene
ESPD uključuje:
1. Temeljni i organizacijski i metodološki standardi
2. Norme koje definiraju oblike i sadržaj programskih dokumenata koji se koriste u obradi podataka
3. Norme koje osiguravaju automatizaciju izrade programskih dokumenata
Izrada organizacijske i metodološke dokumentacije koja definira i regulira aktivnosti organizacija za razvoj, održavanje i rad programa treba se provoditi na temelju ESPD standarda
ESPD standardi podijeljeni su u klasifikacijske skupine
ESPD standardi označeni su kako slijedi:
GOST 19.001-77
19 – standardi koji pripadaju ESPD-u
0 – Opće odredbe
77 – godina odobrenja
GOST 19.503-79- vodič za programiranje sustava. Zahtjevi za sadržaj i dizajn. Obavezni su sažetak i sadržaj. Priručnik programera sustava trebao bi sadržavati sljedeće odjeljke:
1. Opće informacije O programu
Svrha i funkcije programa te podaci o hardveru i softveru koji osiguravaju izvođenje ovog programa
2. Struktura programa
Informacije o strukturi programa, njegovim komponentama, vezama između komponente te o vezama s drugim programima
3. Postavljanje programa
Opis koraka za konfiguriranje programa za određenu aplikaciju (prilagodba sastavu hardvera, izbor funkcija itd.)
4. Provjera programa
Opis metoda testiranja koje nam omogućuju davanje općih zaključaka o izvedbi programa (primjeri testiranja, metode rada, rezultati)
5. Dodatne značajke
Opis dodatnih odjeljaka, funkcionalnost programe i načine njihovog odabira
6. Poruka sistemskom programeru
Tekstovi poruka izdanih tijekom izvođenja programa, opis njihovog sadržaja i radnji koje je potrebno izvršiti nad tim porukama
7. Popis dokumenata
Ovisno o specifičnostima dokumenta, moguće je spajanje pojedinih dijelova i uvođenje novih. U opravdanim slučajevima odjeljak „ dodatne mogućnosti» ne uključiti, ali u nazivima odjeljaka - izostaviti riječ program ili je zamijeniti nazivom programa
Dodatak priručniku programera sustava može sadržavati dodatne materijale (primjere, ilustracije, tablice, grafikone...)
GOST 19.504-79- programerski vodič. Zahtjevi za sadržaj i dizajn. Obavezni su sažetak i sadržaj. Programerski priručnik treba sadržavati sljedeće odjeljke:
1. Namjena i uvjeti korištenja
Svrha i funkcije, uvjeti potrebni za izvođenje (volumen RAM-a, zahtjevi za sastav i parametre periferni uređaji, softverski zahtjevi)
2. Karakteristike programa
Opis glavnih karakteristika i značajki programa (vremenske karakteristike, način rada, sredstva za praćenje ispravnog izvođenja i samoozdravljenja programa)
3. Pristup programu
Opis procedura pozivanja programa (metode prijenosa parametara upravljanja i podataka)
4. I/O podaci
Opis organizacije I/O informacija i, ako je potrebno, njihovo kodiranje
5. Poruka
Tekstovi poruka koje se izdaju programeru ili operateru tijekom izvođenja programa, opis njihovog sadržaja i radnji koje se moraju izvršiti nad tim porukama
6. Popis dokumenata
Ovisno o specifičnostima dokumenta, moguće je spajanje pojedinih dijelova i uvođenje novih. Dodatak programerskom priručniku može sadržavati dodatne materijale (primjere, ilustracije, tablice, grafikone...)
GOST 19.505-79- priručnik za rukovanje. Zahtjevi za sadržaj i dizajn. Obavezni su sažetak i sadržaj. Priručnik za rukovanje trebao bi sadržavati sljedeće odjeljke:
1. Svrha programa
Podaci o namjeni i podaci dovoljni za razumijevanje funkcija programa i njegovog rada
2. Uvjeti za izvođenje programa
Uvjeti potrebni za izvođenje programa (minimalni i (ili) maksimalni sastav hardvera i softver)
3. Izvođenje programa
Redoslijed radnji operatera koji osiguravaju učitavanje, pokretanje i prekid programa (opis funkcija, formata i mogućih opcija naredbi kojima operater učitava i kontrolira izvođenje programa, kao i odgovore programa na te naredbe treba biti osiguran
4. Poruka operateru
Tekstovi poruka izdanih tijekom izvođenja programa, opis njihovog sadržaja i odgovarajućih radnji operatera (radnje operatera u slučaju kvara, mogućnost ponovnog pokretanja programa...)
5. Popis dokumenata
Ovisno o specifičnostima dokumenta, moguće je spajanje pojedinih dijelova i uvođenje novih. Dopušteno je ilustrirati sadržaj odjeljaka primjerima s objašnjenjima, tablicama, dijagramima i grafikonima. U dodatku korisničkog priručnika dopušteno je uključiti razne materijale koje nije prikladno uključiti u odjeljke priručnika