Vienota programmu dokumentācijas sistēma. Vispārīgās prasības programmas dokumentiem. Vienota programmu dokumentācijas sistēma Programmas dokumentu veidi

PSRS Valsts standartu komitejas 1978. gada 18. decembra dekrēts Nr. 3350 noteica ieviešanas termiņu.

Nr. 01.01.1980

Šis standarts nosaka vispārīgas prasības datoru, kompleksu un sistēmu programmu dokumentu izpildei nettkarīgi no to mērķa un apjoma un ko paredz Vienotās programu dokumentācijas sistēmas (ESPD) standarti jebkurai dokumentu izpildes metodei dažādos.

Standards atbilst ST SEV 2088-80 vispārīgajām prasībām informācijas daļas projektēšanai

1. VISPĀRĪGĀS PRASĪBAS

1.1. Politikas dokumentu var noformēt uz dažāda veida datu nesējiem.

1.2. Programmas dokuments sastāv no šādām nosacītajām daļām:

    Titel;

    informativ;

    Papata;

    izmaiņu reģistrācija.

1.3. Dokumenta un tā daļu noformēšanas noteikumus uz katra datu nesēja nosaka ESPD standarti dokumentu noformēšanas noteikumiem uz attiecīgajiem datu nesējiem.

2. NOSAUKUMA DAĻA

2.1. Virsraksta daļa sastāv no apstiprinājuma lapas un titullapa. Apstiprinājuma lapas un titullapas noformēšanas noteikumi ir noteikti saskaņā ar GOST 19.104-78.

3. INFORMĀCIJAS DAĻA

3.1. Informatīvajai daļai jāsastāv no anotācijas un satura.

3.2. Nepieciešamība iekļaut informācijas daļu Dazadi programmas dokumentus nosaka attiecīgie ESPD standarti šiem dokumentiem.

3.3. Anotācija sniedz informāciju par dokumenta mērķi un tā galvenās daļas kopsavilkumu.

    konstrukcijas elementa apzīmējums (nodaļas, apakšnodaļas u.c. numurs);

    konstrukcijas elementa nosaukums;

    strukturālā elementa adrese datu nesējā (piem., lapas numurs, faila numurs utt.).

Noteikumus dokumenta galvenās daļas strukturālo elementu apzīmēšanai un to adresēšanai nosaka ESPD standarti dokumentu apstrādes noteikumiem attiecīgajos datu nesējos.

4. GALVENĀ DAĻA

4.1. Programmas dokumenta galvenās daļas sastāvu un struktūru nosaka ESPD standarti attiecīgajiem dokumentiem.

5. IZMAIŅU REĢISTRACIJAS DAĻA

5.1. Katras izmaiņas programmas dokumentā šajā daļā tiek reģistrētas saskaņā ar GOST 19.603-78 prasībām.

PIELIKUMS Atsauce

INFORMĀCIJAS DATI PAR ATBILSTĪBU GOST 19.105-78 ST SEV 2088-80

Sek. 3 GOST 19.105-78 atbilst Sec. 4 (4.2., 4.3. Punkte) ST SEV 2088-80.

(Eviests papildus. Grozījums Nr. 1)

* Atkārtota izdošana (1987. gada novembris) ar grozījumu Nr. 1, kas apstiprināts 1981. gada septembrī (IUS 11-81)

Šī teksta galvenais mērķis ir izskaidrot, kas ir Wiener System programmas dokumentācija (ESPD) un kā šie standarti tiek piemēroti praksē. Sākšu ar stāstu par to, kas ir standarti, un beigšu ar katra ESPD standarta piemērošanas pieredzi atsevišķi.

Savulaik, kad es tikko sāku strādāt par programmētāju, es bieži dzirdēju "lūdzu, uzrakstiet dokumentāciju savai programmai". Godīgi visu aprakstīju, iedevu priekšniekam, pēc kā sākās melnās maģijas seanss. Pēc brīža man piezvanīja priekšnieks un sāka muldēt neizteiksmīgas skaņas, burzīdams rokās mana „labākā“ teksta izdruku, skraidīdams ar acīm. Viņa pazemojuma vispārējā nozīme bija tāda, ka tas izrādījās „nepareizi“, „nepareizi“ un „paskaties, kā citi dara“. Tā kā citu atbildi no viņa nebija iespējams iegūt, devos meklēt dokumentu piemērus pie „citiem“. Parasti tie bija jautri puiši, kuru runu nozīme bija tāda, ka „šeit ir piemēri“, „faktiski saskaņā ar GOST“ un „tas viss nevienam nav vajadzīgs“. Tāpēc es pirmo reizi uzzināju, ka programmētājs var saskarties ar briesmīgiem valsts standartiem.
Apbrīnojami, ka starp daudziem desmitiem manu kolēģu, ļoti inteliģentu programmētāju, nebija neviena, kas pret GOST izturētos savādāk. Pat tie daži cilvēki, kas viņus pazina un, šķiet, pat prata noformēt dokumentus, izturējās pret viņiem nicinoši-formāli. Situācija, kad pat par attīstības vadību atbildīgie cilvēki nesaprot, kāpēc GOST ir nepieciešami un kā tie tiks piemēroti, daudzos uzņēmumos pastāv visu laiku. Jā, bija uzņēmumi, kas saprata, ar ko „Programmas apraksts“ atšķiras no „Pieteikuma apraksta“, taču tie bija izteikti mazākumā. Internetā parasti dominē viedoklis, ka GOST programmētājiem ir acīmredzams rudiments, un tie ir nepieciešami tikai tad, ja tie „noliecas“ zem tiem. Projekta projekts tiek uzskatīts par "salīdzinoši godīgu veidu, kā no klienta paņemt papildu banknotes". Man tajā nācās iedziļināties un izdomāt salīdzinoši nesen - pašmāju specifikai pielāgotas prasību vadības sistēmas izstrādes procesā. Dokumentācija, kurai, protams, jāģenerē „saskaņā ar GOST“.

Šeit es vēlos koncentrēties tikai uz vienu tēmu, kas programmētājam ir jārisina pašmāju uzņēmumos, it īpaši pētniecības institūtos - uz ESPD standartu kopumu. Es neuzskatu sevi par lielu ESPD ekspertu - ir cilvēki, kas pie tā strādā gadu desmitiem, un viņi mani noteikti izlabos. Rakstā drīzāk mēģināts ieskicēt „ceļa kartes“ aprises tiem, kas tikai sāk.

standardi

Īsi apsvērsim, kas ir standarti (koncentrējoties uz IT jomu).
  1. starptautiskā. pazīšanas zīme- pieņēmusi starptautiska organizācija. Šādas organizācijas piemērs ir ISO ( Starptautiska-Organisation standartizācija). Tā standarta piemērs ir ISO 2382-12:1988 (Perifērijas aprīkojums). ISO un Starptautiskās elektrotehniskās komisijas (IEC, krievu valodā - IEC) kopīgie standarti ir izplatīti: piemēram, ISO / IEC 12207:2008 (programmatūras dzīves cikls);
  2. regionalā. Atšķirīga iezīme - pieņēmusi reģionālā standartizācijas komisija. Piemēram, daudzi padomju GOST tagad ir reģionālais standarts, jo pieņēmusi starpvalstu padome, kurā ietilpst dažas bijušās padomju republikas. Šī padome arī pieņem jaunus standartus - un tie arī saņem GOST apzīmējumu. Piemers: GOST 12.4.240-2013;
  3. standartiem sabiedriskās asociācijas; Piemēram, tas pats IEC: IEC 60255;
  4. valst standartiem. Krievijai šādu standartu sākumā - „GOST R“. Var Hintern tris veidi:
    1. precīzas starptautisko vai reģionālo dokumentu kopijas. Tie ir apzīmēti nettšķirami no „pašrakstītiem“ (valsts, rakstīti nettkarīgi);
    2. starptautiskās vai reģionālās kopijas ar papildinājumiem. Tie tiek norādīti, vietējā standarta šifram pievienojot starptautisko šifru, kas tika ņemts par pamatu. Piemer: GOST R ISO/IEC 12207;
    3. faktiski valsts standarti. Piemēram, GOST R 34.11-94.

Apzīmējumu sistēmas katrā līmenī un katrā organizācijā ir atšķirīgas, katram gadījumam tas būs jāsaprot atsevišķi. Lai ātri saprastu, „kura“ standarts ir jūsu acu priekšā, varat izmantot apkrāptu lapu.

GOST

Tatad: standarti ir starptautiski, starpvalstu (reģionālie) un nacionālie. GOST, kā mēs noskaidrojām, ir reģionālais standarts. GOST ir diezgan mulsinoša, manuprāt, apzīmējumu sistēma. Tas ir pilnībā izklāstīts GOST R 1.5-2004, es došu minimumu, lai tajā varētu orientēties. Pirmkārt, ir jānošķir GOST apzīmējums un tā klasifikācija. Apzīmējums, rupji runājot, ir unikāls standarta identifikators. Klasifikatora kods ir palīgkods, kas palīdz atrast standartu vai notikt, kurai zināšanu jomai tas pieder. Klasifikatoru var būt daudz, galvenokārt tiek izmantoti divi: KGS (klasifikators valsts standarti) un tā pēcteci OKS ( Viskrievijas klasifikators standardi). Piemēram: "GOST R 50628-2000" ir standarta apzīmējums. No apzīmējuma ir skaidrs tikai tas, ka tas pieņemts 2000. gadā. Tam ir OKS kods „33.100;35.160“: t.i. "33" - sadaļa "Telekomunikācijas, audio, video", "100" - apakšsadaļa "Elektromagnētiskā saderība". Tomēr tas ir iekļauts arī klasifikatora filiālē 35.160. „35“ – „Informācijas tehnoloģijas. Biroja tehnika“, „160“ - „Mikroprocesoru sistēmas...“. Un saskaņā ar KGS tam ir kods „E02“, kas nozīmē „E“ - „elektrontehnika, radioelektronika un sakari“, „0“ - „. Vispargi noteikumi un elektroniskās inženierijas, radioelektronikas un sakaru normas” utt.

Ja standarta apzīmējums ir zināms, tad šajā saprātīgajā vietnē varat iegūt tā kodus, piemēram, KGS un OKS.
Tatad, atpakaļ pie GOST apzīmējumiem. Var būt divas iespējas:

  1. standarts attiecas uz standartu sēriju. Šajā gadījumā aiz standarta kategorijas indeksa (piemēram, GOST, GOST R vai GOST RV) nāk sērijas kods, perioden un standarta apzīmējums sērijas ietvaros. Noteikumus standartu noteikšanai sērijā nosaka sērijas noteikumi. Piemēram: GOST RV 15.201-2000, GOST R 22.8.0-99, GOST 19.101-77;
  2. standarts nepieder pie standartu sērijas. Pēc kategoriju indeksa ir vienkārši standarta sērijas numurs, domuzīme un pieņemšanas gads. Piemēram, GOST R 50628-2000.
Tātad, ja tas ir pavisam vienkārši, GOST apzīmējums ir vai nu tikai sērijas numurs, domuzīme, gads vai sērijas numurs, punkts un tālāk, atkarībā no sērijas. Patiesībā viss ir Sarežģītāk (Piemēram, Jūs Varat Atrast Kaut Ko līdzīgu Gost 11326.19-79, un tā visspār nebūs 11326 sērija-Bet programmtāku-igajajadzīgs ļotija.

ESPD

ESPD ir viena no šādām GOST sērijām ar numuru 19. Ti. visi ar ESPD saistītie standarti sākas ar prefiksu „19.“: piemēram, GOST 19.106-78. Tas nozīmē "Vienotā programmu dokumentācijas sistēma". Ir ari citas serijas:
  • GOST ESKD (vienota projektēšanas dokumentācijas sistēma, prefikss „2.“);
  • GOST ESTD (vienota tehnoloģiskās dokumentācijas sistēma, prefikss „3.“);
  • GOST R, Produktu izstrādes un ražošanas sistēma, prefikss „15.“;
  • GOST RV, Bruņojums un militārais aprīkojums. Produktu izstrādes un nodošanas ražošanā sistēma, prefikss „15.“;
  • GOST, System technisko dokumentāciju uz ACS prefikss „24.“;
  • GOST, Standartu komplekts priekš automatizētas sistēmas, Präfix „34.“.
Tātad ESPD satur standartu kopumu, ko izmanto izstrādē Programmatur. Turklat katram ESPD standartam īss apraksts par un skaidrojums neskaidriem gadījumiem.
19.001-77. Vispargi noteikumi
Aprakstīti noteikumi apzīmējumu piešķiršanai ESPD sērijas standartiem. Praksē nav vajadzīgs.
19.102-80. Algoritmu un programmu shemas. Izpildes notikumi.
Apraksta algoritmu konstruēšanas un projektēšanas noteikumus. Izmanto apzīmējumu Nr. 19.103. Manā praksē vienīgā reize bija vajadzīga, kad sertifikācijas laboratorija formāli balstījās uz to, ka ir vajadzīga algoritmu shēma. Manā skatījumā klasiskās blokshēmas ar divām kājām ir pagātnē, un vienīgā vieta, kur tās palika vairāk vai mazāk aktuālas, ir, ja autors vēlas prezentācijā koncentrēt lasītāja uzmanību uz algoritmu.
19.003-80. Algoritmu un programmu shemas. Nosacīti grafiskie simboli
Ir doti pieļaujamo blokshēmas elementu veidu grafiskie apzīmējumi. Nepieciešams, ja tiek izmantotas blokshēmas.
19.004-80. Termini un definedcijas.
Slikta glossarijs. No interesantākajiem - satur formālas programmas un darbības dokumentu definīcijas.
19.005-85. Algoritmu un programmu P-shēmas
Gandrīz aizmirsta valoda. Savulaik P-diagrammas tika plaši izmantotas raķešu un kosmosa industrijā, kļūstot par de facto standartu palaišanas kontroles programmu rakstīšanai un palaišanas simulācijai. Tomēr tagad šī valoda ir pilnībā aizmirsta. Savā darbā es nekad neesmu saskāries ar R shēmām. Lai gan, salīdzinot ar blokshēmām, tām ir manāmas priekšrocības: tās ir kompaktas, piemērotas nelineāru algoritmu (piemēram, klases C++) vai datu struktūru vizualizēšanai. Tajā pašā laikā internetā par tiem praktiski nav informācijas: šī un šī vietne man šķita noderīga. Jebkurā gadījumā, ja man tagad programmatūras dokumentācijā būtu jāievieto algoritma diagramma, es izvēlētos P-diagrammas, nevis blokshēmas.
19.101-77. Programmu veidi un programmas dokumenti
Tajā ir atrodama dokumenta veida un tā koda atbilstības tabula, kā arī dokumenta veidu iedalījums operatīvajos un programmās. Tiek ieviests kompleksa un komponenta jēdziens. Nav neka noderigaka.
19.102-77. Attīstības stadijas
Svarīgs un nepieciešams standarts, kas apraksta dokumentu veidus un nodrošina programmas dokumentu veidu kodus. Šis standarts (kopā ar 19.103-77) ir viens no atslēgām, lai „atšķetinātu“ tādu dokumentu apzīmējumus kā ABVG.10473-01 32 01-1.
Standards ievieš kompleksa un komponenta jēdzienu (vairāki uzņēmumi pievieno trešo veidu - komplektu, ja runa ir par nesaistītiem programmatūras elementiem), tiek dots sadalījums: kuri dokumenti darbojas, kuri ne.
Rūpīgi jāizturas pret 4. tabulu, kurā redzams, kurš dokuments kurā izstrādes stadijā tiek noformēts. Izstrādes posmi parasti tiek reglamentēti P&A standartos, kā arī norādīts, kādi dokumenti katrā posmā ir jāuzrāda pasūtītājam.
19.102-77. Attīstības stadijas
Manā atmiņā šis standarts nekad nav ticis piemērots: kurš, kurā posmā ko dara un kā viņš ziņo, ir notikts TTZ vai ir sniegta atsauce uz GOST, kur tas ir skaidri norādīts (piemēram, GOST RV 15.203). Tajā pašā laikā iesācējam tajā ir apkopojums par darbu galvenajos pētniecības un izstrādes posmos, kas savā lakonismā nav slikts.
19.103-77. Programmu un programmu dokumentu apzīmējumi
Tas ir nepieciešams galvenokārt, lai iemācītos lasīt tādu dokumentu apzīmējumus kā iepriekš. Tomēr apzīmēšanas shēmas izpratne ir noderīga, ja jums ir jaiet ārpus tipiskā darba: piemēram, atcerieties, ka dokumenti, kuru kodi ir pēc 90, ir lietotāja definēti, t.i. jebkura. Manā praksē mēs izdevām 93.dokumentu, ko saucām par „Programmas dokumentācijas lapu“, 96.dokumentu – „Montāžas instrukcijas“.
ESPD nav izplatīta frāze „izpildes versija“, un tā ir aizstāta ar „pārskatīšanas numuru“. No vienas puses, tas nav pilnīgi pareizi: pārskatīšanas numurs tika izveidots, lai izsekotu programmas attīstībai: vispirms tiek izlaists pirmais izdevums, pēc tam, piemēram, pēc pārskatīšanas, otrais. Bet praksē, kad ir jāizlaiž programmatūras versija vairākām operētājsistēmām (starpplatformu programmatūra), citas izejas nav. Precīzāk, ir, bet tas ir nepareizi: katrai operētājsistēmai piešķiriet versiju savam apzīmējumam - un arhivējiet vairākus diskus ar pirmkodiem (atbilstoši operētājsistēmu skajiitam), izstrādskiējietam dokumentāciju utt. ... Ti tīrs ūdens stulba un mulsinoša darbība. Lēmums par katras operētājsistēmas versijas piešķiršanu ar sava versijas numuru ļauj dažus dokumentus padarīt kopīgus.
ESPD tiek izmantots programmas avota tekstu un montāžas rezultāta apzīmējums kā „dokumenti“, kas mulsina daudzus programmētājus. „Programmas teksta“ dokumentam saskaņā ar 19.101-77 ir apzīmējums 12. Tālāk tiek pieņemts, ka pirmkodi ir apzīmēti kā 12 01 - t.i. 01 (pirmais) 12. tipa documents un binārie faili - piemēram, 12 02 - t.i. veidlapas otrais Dokumente 12. Atsevišķos gadījumos, lai izveidotu programmu, papildus Instrumente- kompilatori, uzstādītāju ģeneratori utt. Binden. programmas, kas nav iekļautas piegādē, bet ir nepieciešamas montāžai. Risinājums var būt to apzīmēšana ar 12 03 – t.i. trešais 12. tipa-dokumente.
19.104-78. pamata uzraksti
Apraksta divas dokumenta lapas - apstiprinājuma lapu (AL) un titullapu. ESPD saskaņošanas lapā ir gan dokumentu apstiprinājušo iestāžu paraksti, gan izstrādātāju, normatīvo kontrolieru, pieņemšanas pārstāvju u.c. Binden. tajā ir diezgan daudz uzņēmumam sensitīvas informācijas. Tāpēc standartā ir pieņemts, ka LU paliek jaunattīstības uzņēmumā un tiek nosūtīta tikai pēc īpašiem norādījumiem. Kārtējo reizi LU neietilpst dokumentā, bet it kā ir atsevišķs dokuments, un tas ir iekļauts specifikācijā kā atsevišķa rinda.
Sākotnēji apkaunojošajai dīvainībai, atdalot LL no paša dokumenta, ir ļoti labi iemesli:
  • kā jau minēts, bieži vien uzņēmums nevēlas izpaust informāciju par izstrādātāju. LU atdalīšana un tās „spīlēšana“ ļauj to izdarīt (uz dokumenta lapām ESPD nav zīmoga, visa informācija ir lokalizēta tikai LU);
  • vairāki uzņēmumi izmanto jauktu darbplūsmu: oriģinālie dokumenti tiek glabāti elektroniskā formatā uzņēmuma arhīvā, un uz tiem LU (ar oriģināliem parakstiem) - papīra formātā;
Runājot par LU dizainu, diezgan bieži uzņēmumos tiek izmantots maisījums - daļa LU uzrakstu tiek izsniegti pēc ESPD, daļa - pēc ESKD, bet daļa - savā veidā. Tāpēc vislabāk, pirms pašam taisīt LU, pameklēt uzņēmuma standartu (STO) vai ņemt piemēru no vietējās normatīvās kontroles.
Jāatceras arī, ka LU nav numurēts, un pirmā lapa ir titullapa, un pirmā lapa, kurā ievietots numurs, ir tā, kas atrodas aiz titullapas. Bet gadījumā, ja LU ir vairāk par vienu (tas notiek, ja visi paraksti neder uz lapas), tad LU numurē atsevišķi.
19.105-78. Visparigas prasības politikas dokumentiem
Evasts vispārēja struktūra dokumentu nettkarīgi no tā, kā tas tiek izpildīts. Binden. 1978. gadā standartā tika notikts, ka-Dokumente var nebūt papirs. Jo īpaši satura jēdziens ir ieviests pilnībā elektronische Dokumente. Papīra versijai, kas tajā laikā bija izplatīta, tika pieņemts GOST 19.106-78.
Pašlaik šim standartam ir jāpiekļūst ļoti reti, izņemot to, ka tiek aizmirsta dokumenta galveno daļu secība.
19.106-78. Vispārīgās prasības drukātajiem programmas dokumentiem
Apjomīgākais ESPD standarts, kas ir zemāks tikai par R-shēmu aprakstu. Tas ir galvenais darba standarts dokumentācijas sagatavošanā. Ievieš formatēšanas noteikumus tekstam, dokumentu struktūras elementiem, attēliem, formulām utt. Tomēr atšķirībā no atbilstošā 2.106 no ESKD, 19.106 ir ievērojami mazāk detalizēts, kas rada daudzas neskaidrības.
Pirmkārt, standarts faktiski nenosaka rindstarpu un vertikālās atkāpes apjomu starp virsrakstiem. Tas ievieš trīs atstarpes noteikumus: mašīnrakstītam tekstam, mašīnrakstītam tekstam un tipogrāfiskam tekstam.
Rakstāmmašīnas teksts ir teksts, kas rakstīts ar rakstāmmašīnu. Nakamās rindas nobīde attiecībā pret iepriekšējo tika veikta automātiski ar tā saukto "ratu atgriešanos" - pāreju uz nākamās rindas drukāšanu, kas tika veikta, pārvietojot īpašu sviru. Parasti atstarpi varēja manuāli pielāgot, pagriežot papīra padeves rullīti, un tam bija "iestatījums", lai iestatītu atstarpi uz vienu vai dubultu.
Mašīna - tas, visticamāk, ir drukātais teksts. Bet viņam ir tikai norāde, ka rezultātam jābūt piemērotam mikrofilmēšanai. Tā ir netieša atsauce uz 13.1.002-2003, kas diemžēl nosaka rindstarpu (un, starp citu, minimālo fonta augstumu) tikai ar roku rakstītiem dokumentiem (4.2.5. punkts).
Tipogrāfija - teksts, kas ierakstīts tipogrāfija. Ņemot vērā gadu, kad standarts tika pieņemts, visticamāk, mēs runājam par
[augstspiede, kur rindstarpas tika noteiktas pēc izmantotajām rakstzīmēm. Es neesmu tipogrāfijas eksperts, un šobrīd ir ļoti maz informācijas par salikšanas metodēm.
Kuru intervālu beigās izmantot, bieži nosaka vietējās regulatīvās kontroles vai degvielas uzpildes stacijas. Tipiskās vērtības ir 1.5 atstarpes un 14 fontu lielums.
Dokumenta struktūra bieži rada daudz jautājumu. 19.106 uzskata, ka viss documents ir sadalīts sadaļās, apakšsadaļās, punktos un apakšpunktos. Visiem (izņemot sadaļu un apakšsadaļu) var būt vai nebūt virsraksts. Kura:
  • „dokumenta saturs ietver sadaļu, apakšsadaļu, rindkopu un apakšpunktu skaitu, kuriem ir virsraksts“ (2.1.4. punkts). Tā ir tieša norāde, ka apakšpozīcijai var būt virsraksts un to var iekļaut satura rādītājā;
  • "Tekstu ir atļauts ievietot starp sadaļas un apakšsadaļas virsrakstiem, starp apakšsadaļas un rindkopas virsrakstiem." Ir svarīgi ņemt vērā, ka nenumurētais teksts var atrasties tikai starp virsrakstiem un tikai divos augšējos līmeņos.
Atšķirībā no ESKD, ESPD ir dīvains rasējumu noformēšanas veids: vispirms parādās zīmējuma nosaukums, tad pats zīmējums, pēc tam izvēles „figūras teksts“ un pēc tam jaunā rindā „Zīm. N".
Šim standartam ir vairāki „caurumi“, ordentlichbilstības. Piemēram, ir teikts: „ilustrācijas, ja tās ir also dokumentu vairāk nekā viens, numurēts ar arābu cipariem visā dokumentā. „Bet, ja ir tikai viena ilustrācija, tad tā nav numurēta, un kā tad uz to atsaukties? Tas pats attiecas uz galdiem. Zemsvītras piezīmēm GOST nenorāda, kā tās ir numurētas - visā dokumentā vai lapā.
Tabellen. Pašā dokumentā ir atsauce uz GOST 1.5.68. Spriežot pēc pirmās sērijas, ir viegli secināt, ka šis ir standartu izstrādes standarts. Un šeit viņš ir, nav skaidrs. Pēc nozīmes tas atbilst ESKD tabulu noformēšanas noteikumiem, ar dažiem izņēmumiem. Šis standarts tika atcelts, tā vietā ieviests pēc vairākām iterācijām, 1.5-2012, kurā tabulas formatēšanas noteikumi ... vienkārši pazuda. Vēl 1.5-2002.gadā tie bija, un jau 1.5-2004.gadā pazuda. IN Ista dzive sastādām tabulas pēc ESKD.
Lietojumprogramme. Standards nenorāda, vai skaitļi, formulas un tabulas no pieteikumiem ietilpst vispārīgajā sarakstā. Tāpat nav teikts, vai satura rādītājā ir jāatklāj lietojumprogrammas struktūra, ja tajā ir savas sadaļas, rindkopas utt. Mūsu praksē mēs nettklājam lietojumprogrammu iekšējos elementus.
Visbeidzot, jāsaka par ievilkumiem. 5 rakstzīmju rindkopas atkāpe ir izplatīta:
  • sarkanā līnija;
  • dokumenta struktūras elementa atkāpe aiz sadaļas (apakšnodaļas, rindkopas, apakšpunkta);
  • Enum-Elemente.

  • Šajā gadījumā teksts, kas attrodas nākamajā rindā pēc atkāpes līnijas, jau ir līdzināts kreisajai piemalei. Bieži vien ir kļūdas, kad atkāpe lec - sarkanā līnija - viena vērtība, preces numurs - mums ar citu intervālu, ligzdotos atkāpēs sarakstos - tas parasti ir nepieciešams.

    Nākamajās daļās plānoju nonākt līdz ESPD standartu saraksta beigām.

GOST 19.105-78

Gruppe T55

STARPVALSTU-STANDARTEN

Vienota programmu dokumentācijas sistēma

VISPĀRĪGĀS PRASĪBAS PROGRAMMU DOKUMENTIEM

Vienota programmu dokumentācijas sistēma. Vispārīgās prasības programmas dokumentiem

MKS35.080

Ievadīšanas Datum 1980-01-01


PSRS Valsts standartu komitejas 1978. gada 18. decembra dekrēts N 3350, ieviešanas datums tika notikts 01.01.80.

IZDEVUMS (2010. gada janvāris) ar grozījumu Nr. 1, kas apstiprināts 1981. gada septembrī (IUS 11-81).


Šis standarts nosaka vispārīgas prasības datoru, kompleksu un sistēmu programmu dokumentu izpildei nettkarīgi no to mērķa un apjoma un ko paredz Vienotās programu dokumentācijas sistēmas (ESPD) standarti jebkurai dokumentu izpildes metodei dažādos.

Standards atbilst ST SEV 2088-80* vispārīgajām prasībām informācijas daļas projektēšanai (sk. Pielikumu).
________________
* Piekļuvi tekstā minētajiem starptautiskajiem un ārvalstu dokumentiem var iegūt, sazinoties ar Lietotāju atbalsta dienestu. - Datu bāzes ražotāja piezīme.

(Izmainīts izdevums, Rev. Nr. 1).

1. VISPĀRĪGĀS PRASĪBAS

1. VISPĀRĪGĀS PRASĪBAS

1.1. Politikas dokumentu var noformēt uz dažāda veida datu nesējiem.

1.2. Programmas dokuments sastāv no šādām nosacītajām daļām:

Titel;

informativ;

Papata;

izmaiņu reģistrācija.

1.3. Dokumenta un tā daļu noformēšanas noteikumus uz katra datu nesēja nosaka ESPD standarti dokumentu noformēšanas noteikumiem uz attiecīgajiem datu nesējiem.

2. NOSAUKUMA DAĻA

2.1. Tituldaļa sastāv no apstiprinājuma lapas un titullapas.

Noteikumi apstiprinājuma lapas un titullapas noformēšanai - saskaņā ar GOST 19.104-78.

3. INFORMĀCIJAS DAĻA

3.1. Informatīvajai daļai jāsastāv no anotācijas un satura.

3.2. Nepieciešamību iekļaut informācijas daļu dažāda veida programmas dokumentos nosaka attiecīgie ESPD standarti šiem dokumentiem.

3.3. Anotācija sniedz informāciju par dokumenta mērķi un tā galvenās daļas kopsavilkumu.

3.4. Saturā ir iekļauts ierakstu saraksts par dokumenta galvenās daļas strukturālajiem elementiem, no kuriem katrs ietver:

konstrukcijas elementa apzīmējums (nodaļas, apakšnodaļas u.c. numurs);

konstrukcijas elementa nosaukums;

strukturālā elementa adrese datu nesējā (piem., lapas numurs, faila numurs utt.).

Noteikumus dokumenta galvenās daļas strukturālo elementu apzīmēšanai un to adresēšanai nosaka ESPD standarti dokumentu apstrādes noteikumiem attiecīgajos datu nesējos.

4. GALVENĀ DAĻA

4.1. Programmas dokumenta galvenās daļas sastāvu un struktūru nosaka ESPD standarti attiecīgajiem dokumentiem.

5. IZMAIŅU REĢISTRACIJAS DAĻA

5.1. Katras izmaiņas programmas dokumentā šajā daļā tiek reģistrētas saskaņā ar GOST 19.603-78 prasībām.

PIELIKUMS (atsauce). INFORMĀCIJAS DATI PAR ATBILSTĪBU GOST 19.105-78 ST SEV 2088-80

PIELIKUMS
Atsauce

GOST 19.105-78 3. sadaļa atbilst ST SEV 2088-80 4. sadaļai (4.2., 4.3. punkts).

(Eviests papildus, Rev. N 1).



Dokumenta elektroniskais teksts
sagatavojusi AS Kodeks un pārbaudīta pret:
oficiālā publikācija
Vienota programmu dokumentācijas sistēma:
Valsts standartu kolekcija. -
M.: Standartinform, 2010

Vienotā programmu dokumentācijas sistēma ir valsts standartu kopums, kas nosaka savstarpēji saistītus noteikumus programmu un programmu dokumentācijas izstrādei, izstrādei un apritei.

Espd-Satavs

GOST 19.004 ESPD. Termini un definedcijas.

GOST 19.101 ESPD. Programmu veidi un programmas dokumenti.

GOST 19.102 ESPD. Attīstības stadijas.

GOST 19.103 ESPD. Programmu un programmu dokumentu apzīmējumi.

GOST 19.104 ESPD. Pamata uzraksti.

GOST 19.105 ESPD. Vispārīgās prasības programmas dokumentiem.

GOST 19.106 ESPD. Prasības programmas dokumentiem, kas izgatavoti drukātā veidā.

GOST 19.201 ESPD. Tehniskais uzdevums. Prasibas saturam und dizainam.

GOST 19.202 ESPD. Spezifikacija. Prasibas saturam und dizainam.

GOST 19.401 ESPD. Programmtexte. Prasibas saturam und dizainam.

GOST 19.402 ESPD. Programme apraksts.

GOST 19.501 ESPD. Veidlapa. Prasibas saturam und dizainam.

GOST 19.502 ESPD. Visparigs apraksts. Prasibas saturam und dizainam.

GOST 19.503 ESPD. Sistēmas programmētāja rokasgrāmata. Prasibas saturam und dizainam.

GOST 19.504 ESPD. Programmētāja rokasgrāmata. Prasibas saturam und dizainam.

GOST 19.505 ESPD. Operatora rokasgrāmata. Prasibas saturam und dizainam.

GOST 19.506 ESPD. Valodas apraksts. Prasibas saturam und dizainam.

GOST 19.601 ESPD. Vispārīgi noteikumi dublēšanai, uzskaitei un uzglabāšanai.

GOST 19.602 ESPD. Drukātā veidā izgatavotu programmas dokumentu pavairošanas, uzskaites un uzglabāšanas noteikumi.

GOST 19.603 ESPD. Vispārīgi noteikumi izmaiņu veikšanai.

GOST 19.604 ESPD. Noteikumi izmaiņu veikšanai programmas dokumentos, kas izgatavoti drukātā veidā.

GOST 19.001 ESPD. Vispargi noteikumi.

Vienotā programmu dokumentācijas sistēma (ESPD) ir valsts standartu kopums, kas nosaka savstarpēji saistītus noteikumus programmu un programmu dokumentācijas izstrādei, izpildei un apritei.

ESPD standarti nosaka prasības, kas reglamentē

attistaba,

Begleitpersonen,

Razosana un

Programme darbiba.

ESPD standartos notiktie notikumi un notikumi attiecas uz datoru, kompleksu un sistēmu programmatūras dokumentāciju nettkarīgi no to mērķa un apjoma.

ESPD ietver šādas standartu grupas:

0 - vispargi noteikumi.

1 - Pamatstandarti.

2 - Attīstības dokumentācijas ieviešanas noteikumi.

3 - Ieviešanas dokumentācijas ieviešanas noteikumi.

4 - Tehniskās apkopes dokumentācijas ieviešanas noteikumi.

5 - Operatīvās dokumentācijas ieviešanas noteikumi.

6 - Programmas dokumentācijas aprites noteikumi.

7 - Reservegruppe.

8 - Reservegruppe.

9 - Citi standarti.

GOST 19.101 ESPD. Programmu veidi un programmas dokumenti.

Standards nosaka programmu un programmu dokumentu veidus datoriem, kompleksiem un sistēmām nettkarīgi no to mērķa un apjoma.

Programm:

Programma-Originale. Programma, kas paredzēta tās dublikātu glabāšanai un reproducēšanai.

Duplikate von Programmen. Programma, kas ir oriģinālās programmas kopija un ir paredzēta glabāšanai un kopiju izgatavošanai.

Programme kopieren. Programma, kas paredzeta tiešai lietošanai.

Politikas dokumentu veidi(paraugs datora programmu izstrādes nosacījumiem):

Tehniskais uzdevums. Programme mērķis un apjoms, tehniskās, tehniskās, ekonomiskās un īpašās prasības programmai, nepieciešamie izstrādes posmi un termiņi, testu veidi.

Spezifikacija. Programmas struktūra un dokumentācija par to.

Oriģināla turētāju Saraksten. Uzņēmumu saraksts, kas glabā oriģinālās programmas un oriģinālo programmu dokumentāciju.

Programmtexte. Uzrakstiet programmu ar nepieciešamajiem komentāriem.

Programme apraksts. Informācija par programmas loģisko uzbūvi un darbību.

Paskaidrojuma Piezime. Pieņemto tehnisko risinājumu pamatojums, programmas funkcionēšanas vispārīgā algoritma apraksts.

Pārbaudes procedūra un metodes. Programmes testēšanas laikā pārbaudāmās prasības, kā arī to kontroles kārtība un metodes.

Operatora (lietotāja) rokasgrāmata. Informācija, lai nodrošinātu saziņas kārtību ar datoristēmu programmas izpildes laikā.

GOST 19.102 ESPD. Attīstības stadijas.

Attīstības stadija

Posmen von Darba

Tehniskais uzdevums

Programmas izstrādes nepieciešamības pamatojums

Probleme formulēšana.

Izejmaterialu vākšana.

Programmes efektivitātes kritēriju izvēle.

Pētniecības nepieciešamības pamatojums.

Petnieciskais darbs

Ievades un izvaddatu strukturas noteikšana.

Problēmu risināšanas metožu iepriekšēja izvēle.

Iepriekš izstrādāto programmu izmantošanas lietderības pamatojums.

Prasību noteikšana tehniskajiem līdzekļiem.

Problēmas risināšanas pamatiespējas pamatojums.

TOR izstrade un apstiprināšana

Prasību notikšana programmai.

Priekšizpētes izstrāde programmu izstrādei.

Attīstības posmu, posmu un termiņu definīcija.

Programmēšanas valodu izvēle.

TK saskaņošana un apstiprināšana.

Sakotnējais dizains

ES attistība

Ievades un izvaddatu struktūras sākotnējā izstrāde.

Problēmas risināšanas metožu pilnveidošana.

Vispārīga algoritma izstrade problēmas risināšanai.

Priekšizpētes izstrade

EP apstiprinajums

EP saskaņošana un apstiprināšana.

Tehniskais-Projekte

TP attistība

Ievades un izvaddatu struktūras pilnveidošana.

Algoritma izstrade problēmas risināšanai.

Ievades un izejas datu attēlojuma formas noteikšana.

Valodas semantikas un sintakses definicija.

Programmas strukturas izstrade.

Aparatūras konfigurācijas galīgā definīcija.

TP apstiprinajums

Rīcības plāna izstrāde programmu izstrādei un īstenošanai.

Paskaidrojuma raksta izstrade.

TP saskaņošana un apstiprināšana.

darba-Projekte

Programme izstrade

Programmes programmēšana un atkļūdošana

Oriģinālās programmas izgatavošana.

Programmas dokumentācijas izstrade

Programmatūras dokumentācijas izstrāde.

Programme parbaude

Testēšanas kārtības un metodikas izstrāde, saskaņošana un apstiprināšana.

Testēšana.

Programme un programmas dokumentācijas korekcija, pamatojoties uz testa rezultātiem.

Īstenošana

Programme sagatavošana un nodošana

Programme un dokumentācijas sagatavošana un nodošana apkopei.

Programmas nodošanas uzturēšanai akta reģistrācija un apstiprināšana.

Programmas nodošana algoritmu un programmu fondā.

GOST 19.201 ESPD. Tehniskais uzdevums. Prasibas saturam und dizainam.

Standards nosaka datoru, kompleksu un sistēmu programmas vai programmatūras produkta izstrādes tehnisko specifikāciju konstruēšanas un izpildes kārtību nettkarīgi no to mērķa un apjoma.

Darba uzdevumā jāiekļauj šādas sadaļas:

Nosaukums un darbibas joma.

Sadaļā ir norādīts nosaukums, īss darbības jomas, programmas vai programmatūras produkta apraksts un objekts, kurā programma vai programmatūras produkts tiek izmantots.

Pamats attīstībai.

Sadaļā jānorāda-Dokumente, uz kura pamata tiek veikta izstrāde.

Attīstības mērķis.

Sadaļā jānorāda programmas vai programmatūras produkta funkcionālais un darbības mērķis.

Programme vai programmatūras produkta tehniskās prasības.

Sadaļā jāiekļauj šādas apakšsadaļas:

veiktspējas prasības.

Ekspluatācijas apstākļi.

Prasības tehnisko līdzekļu sastāvam un parametriem.

Prasības informācijas un programmatūras saderībai.

Apakšsadaļā "Prasības funkcionālajiem raksturlielumiem" jānorāda prasības izpildāmo funkciju sastāvam, ievades un izvades datu organizācijai, laika raksturlielumiem utt.

Apakšsadaļā "Prasības tehnisko līdzekļu sastāvam un parametriem" norāda nepieciešamo tehnisko līdzekļu sastāvu, norādot zu tehniskos raksturlielumus.

Apakšsadaļā "Prasības informācijai un programmu saderībai" jānorāda prasības informācijas struktūrām pie ievades un izvades un risinājuma metodēm, pirmkodiem, programmēšanas valodām.

Tehniskie un ekonomiskie rādītāji.

Sadaļā norādīta aplēstā ekonomiskā efektivitāte, paredzamā gada nepieciešamība, attīstības ekonomiskie ieguvumi, salīdzinot ar labākajiem paraugiem un analogiem.

Posmi un attīstības stadijas.

Steuert un pieņemšanas procedūra.

Sadaļā jānorāda pārbaužu veidi un vispārīgās prasības darbu pieņemšanai.

GOST 19.402 ESPD. Programme apraksts.

Dokuments sastāv no informatīvās daļas (abstrakts un saturs) un galvenās daļas (funkcionālais mērķis, loģiskais apraksts).

Sadaļā "Funkcionālais mērķis" ir norādīts programmas mērķis un sniegts vispārīgs programmas darbības apraksts un informācija par lietošanas ierobežojumiem.

Sadaļā "Loģikas apraksts" norādiet:

Programmas struktūras un tās sastāvdaļu apraksts.

Sastavdaļu funkciju un to savstarpējo attiecību apraksts.

Informācija par programmēšanas valodu.

Katras sastavdaļas ievades un izvades datu apraksts.

Sastavdaļu loģikas apraksts (ja nepieciešams, tiek apkopoti programmu shēmu apraksti).

Aprakstot programmas loģiku, nepieciešams izveidot saiti uz programmas tekstu.

GOST 19.505 ESPD. Operatora rokasgrāmata. Prasibas saturam und dizainam.

Dokumentā jābūt šādām sadaļām:

Programmas mērķis.

Pieteikšanas nosacījumi.

Programme Sakums.

Operatora-Befehle.

operatora ziņas.

Programmas sākšanas sadaļā ir jānorāda darbības, kas jāveic, lai nodrošinātu programmas ielādi un palaišanu.

Sadaļā "Operatora komandas" ir jāapraksta funkcijas un iespējamās opcijas komandām, ar kurām operatoren ielādē un kontrolē programmas izpildi, kā arī operatora darbības, kad programma beidzas.

Sadaļā "Ziņojumi operatoram" jābūt programmas izpildes laikā izdoto ziņojumu tekstiem, to satura aprakstam un atbilstošām operatora darbībām (operatora darbības kļūmes gadījumā, programmas restartēšanas iespēja).

Standartu kopums automatizētām sistēmām (KSAS)

Vienotā programmu dokumentācijas sistēma (ESPD) ir vietējais programmu dokumentācijas standartu kopums. Profesionālajā valodā to sauc arī par "deviņpadsmito viesi", kas nav pilnīgi pareizi, jo mēs runājam nevis par vienu, bet par 30 dažādiem normatīvajiem un tehniskajiem dokumentiem.

Pamatā ESPD standarti satur prasības programmu aprakstošo dokumentu sastāvam, saturam un izpildei dažādos tās dzīves cikla posmos. Turklāt vairāki dokumenti ir veltīti dokumentācijas glabāšanas un atjaunināšanas procedūrai.

ESPD standartos praktiski nav metodoloģiskās sastāvdaļas. Tie neizskaidro izstrādātājam, kā rakstīt dokumentāciju, lai tā būtu noderīga, saprotama, informatīva, ērta utt. Tie nodrošina tikai dokumentu tipu sarakstu un katrai no tām pirmā līmeņa sadaļu sarakstu. Tiesa, katrā sadaļā ir norādīts, kāda informācija tajā ir jāuzrāda.

ESPD standarti tika pieņemti 70. gadu beigās un ir nonākuši līdz mums oriģinālam tuvā formā. Krawatte atspoguļo departureamentu skaitļošanas centru darba praksi, kur tika darbināti lieli datori. Cilvēka mijiedarbība ar datoristēmu toreiz tika veidota pavisam citādāk nekā tagad un tika veikta ar apjomīgām pultīm, perfokartēm un izdrukām, un „vienkāršiem mirstīgajiem“ risinot liemastišķas problīvaldmas, patīpaldmas Vai ir ilgi jāskaidro, cik šie standarti jau ir novecojuši? Pietiek pateikt, ka viņi nezina par mūsdienās plaši izplatītiem dokumentiem, piemēram, Lietotāja rokasgrāmatu un Administratora rokasgrāmatu.

Un tomēr tos turpina aktivi izmantot. Formāli "deviņpadsmitais" ir moderna alternatīva. Daži ISO / IEC standarti sistēmu un programmatūras inženierijas jomā ir tulkoti krievu valodā un pieņemti Krievijā kā nacionālie standarti. Taču lielie, tostarp valdības klienti, nesteidzas uz tiem pāriet. Zu var izskaidrot ar viņu inerci (vai lojalitāti tradīcijām, kā vēlaties), bet tikai daļēji.

Lieta tāda, ka visi ESPD-Standards ar nelielu (maksimāli trīs lappušu) apjomu ir kopums diezgan formāls un tāpēc viegli parbaudams prasības dokumentam vai dokumentācijas kopumam. Stingri sakot, tas neliedz dokumentācijas izstrādātājam rakstīt labi izveidotas muļķības. Bet, tā kā ESPD ir skaidri definēts, no kā jāsastāv rezultātam un kā tam jāizskatās, mēs varam vismaz uzreiz noraidīt papīra kaudzi, kas neietilpst šajos rāmjos. Tas ievērojami vienkāršo dokumentācijas piegādes un pieņemšanas uzdevumu gan pasūtītājam, gan darbuzņēmējam.

No otras puses, ISO/IEC standardi satur daudz saprātīgu būtisku noteikumu, taču ir grūti iedomāties procedūru to formālai pārbaudei. Taču neviens neapgrūtina abus standartu kopumus vienlaikus piemērot, par laimi, tie attiecas uz dažādiem dokumentācijas aspektiem un praktiski nav pretrunā viens otram.

Normatīvo un tehnisko dokumentu sastādīšana

Apzīmējums Vārds
GOST 19.001-77
Vispargi noteikumi
GOST 19.002-80 Vienota programmu dokumentācijas sistēma.
Algoritmu un programmu shemas. Izpildes notikumi
GOST 19.004-80 Vienota programmu dokumentācijas sistēma.
Termini undefined
GOST 19.005-85 Vienota programmu dokumentācijas sistēma.
Algoritmu un programmu P-shēmas. Nosacīti grafiskie apzīmējumi un izpildes noteikumi
GOST 19.101-77 Vienota programmu dokumentācijas sistēma.
Programmu veidi un programmas dokumenti
GOST 19.102-77 Vienota programmu dokumentācijas sistēma.
Attīstības stadijas
GOST 19.103-77 Vienota programmu dokumentācijas sistēma.
Programmu un programmu dokumentu apzīmēšana
GOST 19.104-78 Vienota programmu dokumentācijas sistēma.
pamata uzraksti
GOST 19 105-78 Vienota programmu dokumentācijas sistēma.
Vispārīgās prasības programmas dokumentiem
GOST 19.106-78 Vienota programmu dokumentācijas sistēma.
Prasības programmas dokumentiem, kas izgatavoti drukātā veidā
GOST 19.201-78 Vienota programmu dokumentācijas sistēma.
Tehniskais uzdevums
GOST 19.202-78 Vienota programmu dokumentācijas sistēma.
Spezifikacija. Prasības saturam un dizainam
GOST 19.301-79 Vienota programmu dokumentācijas sistēma.
Programma un testa-Verfahren. Prasības saturam un dizainam
GOST 19.401-78 Vienota programmu dokumentācijas sistēma.
Programmtexte. Prasības saturam un dizainam
GOST 19.402-78 Vienota programmu dokumentācijas sistēma.
Programme apraksts
GOST 19 403-79 Vienota programmu dokumentācijas sistēma.
Oriģinālo turētāju Saraksten
GOST 19.404-79 Vienota programmu dokumentācijas sistēma.
Paskaidrojuma Piezime. Prasības saturam un dizainam
GOST 19.501-78 Vienota programmu dokumentācijas sistēma.
Veidlapa. Prasības saturam un dizainam
GOST 19.502-78 Vienota programmu dokumentācijas sistēma.
Pielietojuma apraksts. Prasības saturam un dizainam
GOST 19.503-79 Vienota programmu dokumentācijas sistēma.
Sistēmu programmētāja rokasgrāmata. Prasības saturam un dizainam
GOST 19.504-79 Vienota programmu dokumentācijas sistēma.
Programmētāja rokasgrāmata
GOST 19.505-79 Vienota programmu dokumentācijas sistēma.
Operatora rokasgrāmata. Prasības saturam un dizainam
GOST 19.506-79 Vienota programmu dokumentācijas sistēma.
Valodas apraksts. Prasības saturam un dizainam
GOST 19.507-79 Vienota programmu dokumentācijas sistēma.
Ekspluatācijas dokumentu izziņa
GOST 19.508-79 Vienota programmu dokumentācijas sistēma.
Vadit apkope. Prasības saturam un dizainam
GOST 19.601-78 Vienota programmu dokumentācijas sistēma.
Vispārīgi noteikumi dublēšanai, uzskaitei un uzglabāšanai
GOST 19.602-78 Vienota programmu dokumentācijas sistēma.
Drukātā veidā izgatavotu programmas dokumentu pavairošanas, uzskaites un uzglabāšanas noteikumi
GOST 19.603-78 Vienota programmu dokumentācijas sistēma.
Vispārīgi noteikumi izmaiņu veikšanai
GOST 19.604-78 Vienota programmu dokumentācijas sistēma.
Noteikumi izmaiņu veikšanai programmas dokumentos, kas izgatavoti drukātā veidā

Standartu iegūšana