Reguli pentru pregătirea documentației software

Acest ghid se referă la întocmirea de rapoarte privind programele create de studenți în timpul orelor practice la diferite discipline. Prevederile generale ale acestor reguli sunt aplicabile și la pregătirea secțiunilor individuale de cursuri și lucrări de calificare, rapoarte privind practica industrială și educațională și lucrările de cercetare ale studenților, dacă rezultatul sau o anumită etapă a unei astfel de lucrări este un produs software sau un modul software creat.

Documentația software este o componentă integrală a produsului software și trebuie întocmită în conformitate cu Sistemul unificat de documentație software (USPD - GOST seria 19). Ca parte a activității educaționale, este permisă includerea întregului conținut al documentației programului într-un singur „raport de program”, în timp ce cerințele formale pentru întocmirea unui astfel de raport corespund cerințelor pentru un raport de cercetare. Această secțiune evidențiază punctele cheie ale standardelor de stat DESE.

Documentația programului, pe lângă documentele formale (caietul de sarcini, lista deținătorilor originali, formular etc.), include:

• termenii de referință (scopul, domeniul de aplicare al programului, cerințele pentru program);
• textul programului (înregistrarea programului cu comentariile necesare);
• descrierea programului (informații despre structura logică și funcționarea programului);
• nota explicativa (diagrama algoritmului, descrierea generala a functionarii algoritmului si/sau programului, justificarea deciziilor luate);
• documente operaționale.

Documentul de program „Notă explicativă” se întocmește în etapa de proiectare preliminară sau tehnică a programului. De obicei, nu este utilizat în etapa de proiectare detaliată.

Documentele operaționale includ:

• descrierea aplicației (informații despre scopul programului, domeniul de aplicare, metodele utilizate, clasa de probleme de rezolvat, restricții de utilizare, configurația minimă a hardware-ului);
• ghidul programatorului de sistem (informații pentru verificarea, asigurarea funcționării și personalizarea programului pentru condițiile unei anumite aplicații);
• ghidul programatorului (informații pentru operarea programului);
• manualul operatorului (informații care să asigure comunicarea între operator și sistemul informatic în timpul execuției programului);
• descrierea limbii (descrierea sintaxei și semanticii limbajului);
• manual de întreținere (informații pentru utilizarea programelor de testare și diagnosticare la întreținerea echipamentelor tehnice)

Partea principală a documentației software este compilată în etapa de proiectare detaliată. Necesitatea unui anumit document este determinată în etapa de elaborare a specificațiilor tehnice. Este permisă combinarea anumitor tipuri de documente.

Documentul operațional „Descrierea limbii” este inclus în documentația programului dacă produsul software dezvoltat implementează un anumit limbaj de programare, managementul sarcinilor, organizarea procesului de calcul etc.

Documentul operațional „Manual de întreținere” este inclus în documentația software dacă produsul software dezvoltat necesită utilizarea programelor de testare sau de diagnosticare.

Termenii de referință includ:

• introducere (nume, descriere succintă a domeniului de aplicare a programului);
• temeiurile dezvoltării (documente pe baza cărora se realizează dezvoltarea, organizația care a aprobat documentele, data aprobării, denumirea și denumirea temei de dezvoltare);
• scopul dezvoltării (scopul funcțional și operațional al programului);
• cerințe pentru program și documentația programului;
• indicatori tehnico-economici;
• stadii și stadii de dezvoltare;
• procedura de control si acceptare.

Partea cea mai esențială a specificației tehnice este secțiunea „cerințe”. » Această secțiune conține:

• cerințe pentru caracteristicile funcționale (compunerea funcțiilor îndeplinite, organizarea datelor de intrare și de ieșire, caracteristici de sincronizare);
• cerințe de fiabilitate (asigurarea funcționării stabile, monitorizarea informațiilor de intrare și ieșire, timp de recuperare după o defecțiune);
• cerințe privind compatibilitatea informațiilor și software-ului (cerințe pentru structurile informaționale la intrare și ieșire, metode de soluție, coduri sursă, limbaje de programare și software; cerințe pentru protecția informațiilor);
• cerințe pentru compoziția și parametrii mijloacelor tehnice;
• cerințe pentru documentația software.

Această secțiune poate conține cerințe pentru etichetare, ambalare, transport și depozitare, precum și condiții de funcționare.

Pe lângă cerințele descrise în mod explicit în specificațiile tehnice, ar trebui să respectați regulile general acceptate pentru dezvoltarea programului, ținând cont de paradigma de programare aleasă:

1. Programul nu trebuie să conțină elemente redundante (toate elementele programului sunt adecvate sarcinii în cauză: nu există elemente bucle, matrice etc. de care să se renunțe).
2. Algoritmul trebuie să fie structurat: pentru un stil de programare funcțional - o defalcare adecvată în funcții (proceduri), pentru un stil orientat pe obiecte - o ierarhie adecvată a claselor. Fiecare funcție (metoda de clasă) trebuie să implementeze exact o acțiune.
3. Funcțiile (metodele clasei) trebuie să aibă parametri. Utilizarea variabilelor globale în funcții ar trebui evitată.
4. Programul trebuie să folosească memoria cu atenție: lucrează cu matrice dinamice, nu trebuie să conțină blocuri de memorie neutilizate sau variabile inutile.
5. Intervalele de valori introduse de utilizator și parametrii trecuți între modulele programului trebuie verificate.
6. Când utilizați componente gata făcute (funcții de bibliotecă, clase) într-un program, dacă o funcție sau o metodă de clasă poate eșua, este necesar să verificați acest lucru fără a ne baza pe nesemnificația probabilității unui astfel de eveniment.
7. Programul trebuie să fie configurabil (parametrii importanți ai programului ar trebui să fie separați într-un singur bloc).

Textul programului este o înregistrare simbolică în limba sursă sau intermediară sau o reprezentare simbolică a codurilor de mașină. Textul programului este formatat într-un font monospațiu (Courier, Lucida Console etc.) în conformitate cu standardele de proiectare general acceptate:

1. Numărul de operatori pe linie trebuie să fie 1.
2. Toate instrucțiunile incluse într-o instrucțiune compusă trebuie să fie deplasate la dreapta cu același număr de poziții, iar parantezele operatorului (adică ceea ce limitează instrucțiunea compusă) aparținând aceluiași bloc trebuie plasate după cum urmează: paranteza de deschidere trebuie să fie pe că aceeași linie cu instrucțiunea care deschide blocul și linia de închidere trebuie să fie în aceeași coloană cu care începe instrucțiunea care deschide blocul. Este permisă plasarea parantezei de deschidere pe linia care urmează instrucțiunii care deschide blocul, în aceeași coloană cu care începe acea afirmație.
3. Întreaga linie de text sursă a programului trebuie să fie amplasată pe o singură linie tipografică (până la 80 de caractere în funcție de font). Nerespectarea acestei reguli indică o imbricare prea mare a blocurilor, ceea ce înseamnă un algoritm sau o structură de program nereușită. În acest caz, se recomandă regândirea structurii programului, introducerea de funcții suplimentare, înlocuirea unor părți mari ale codului cu apelurile lor, refacerea algoritmului etc.
4. Dacă sintaxa limbajului permite, este indicat să se separe semnele operației cu spații de operanzi. Ca și în textul obișnuit, virgulele trebuie să fie urmate de un spațiu.
5. Definițiile funcțiilor sau părțile logice ale unui program trebuie separate între ele prin linii goale.
6. Identificatorii (numele variabilelor, tipurile, subrutinele) trebuie să fie atât de semnificativi încât cititorul textului programului să le poată înțelege sensul fără prezența autorului. Dacă este necesar, o declarație de variabilă sau de tip poate fi însoțită de un comentariu.
7. Textul programului trebuie să conțină comentarii care să reflecte scopul funcțional al unui anumit bloc de program și structura programului.

Documentul „Descrierea programului” conține:

• informații generale (denumirea, denumirea programului, software-ul necesar pentru funcționarea programului, limbaje de programare în care este scris programul);
• scop funcțional (clase de sarcini de rezolvat, informații despre restricțiile funcționale ale aplicației);
• descrierea structurii logice (algoritmul programului, metodele utilizate, structura programului cu descrierea componentelor și conexiunile dintre acestea);
• mijloacele tehnice utilizate (tipuri de calculatoare și dispozitive care sunt utilizate la rularea programului);
• apel și încărcare (metodă de apelare a unui program din mediul de stocare corespunzător);
• datele de intrare (natura, organizarea și pregătirea preliminară a datelor de intrare, precum și formatul, descrierea și metoda de codificare a acestora);
• datele de ieșire (natura și organizarea datelor de ieșire, precum și formatul, descrierea și metoda de codificare).

Descrierea structurii logice a programului ar trebui să fie însoțită de o diagramă bloc a programului.

Documentul „Descrierea programului” poate conține, de asemenea, diagrame de date, diagrame de interacțiune cu programe, diagrame de resurse de sistem etc., concepute în conformitate cu GOST 19.701-90.

Documentul „Descrierea aplicației” se referă la documente operaționale și constă din următoarele secțiuni:

• scopul programului (capacități, caracteristici principale, limitări ale domeniului de aplicare);
• condiții de utilizare (cerințe pentru hardware și software, caracteristici generale ale informațiilor de intrare și de ieșire, precum și cerințe și condiții de natură organizatorică, tehnică și tehnologică);
• descrierea problemei (se indică definițiile problemei și metodele de rezolvare a acesteia);
• date de intrare și de ieșire.

Ghidul programatorului de sistem

Documentul „Ghidul programatorului de sistem” se referă la documente operaționale și este inclus în documentația programului dacă produsul software dezvoltat necesită întreținere de către un programator de sistem. Documentul constă din următoarele secțiuni:

• informatii generale despre program (scopul si functiile programului, informatii despre hardware si software care asigura executia acestui program);
• structura programului (informații despre structură, relațiile dintre modulele programului și cu alte programe);
• stabilirea programului (stabilirea compoziției mijloacelor tehnice, selectarea funcțiilor etc.);
• verificarea programului (metode și tehnici de verificare, cazuri de testare, metode de rulare, rezultate);
• caracteristici suplimentare;
• mesaje către programatorul sistemului (texte ale mesajelor emise în timpul configurării, testării programului, în timpul execuției programului și o descriere a acțiunilor care trebuie întreprinse ca răspuns la aceste mesaje).

Documentul „Ghidul programatorului” se referă la documente operaționale și este inclus în documentația programului dacă produsul software dezvoltat necesită întreținere de către un programator. Documentul constă din următoarele secțiuni:

• scopul și condițiile de utilizare ale programului (scopul și funcțiile programului, informații despre hardware și software care asigură executarea acestui program);
• caracteristicile programului (caracteristici de timp, moduri de operare, mijloace de monitorizare a executării corecte etc.);
• acces la program (metode de transfer al parametrilor de control și date);
• date de intrare și de ieșire (format și codare);
• mesaje (textele mesajelor transmise programatorului sau operatorului în timpul execuției programului și o descriere a acțiunilor care trebuie întreprinse ca răspuns la aceste mesaje).

Documentul „Manualul operatorului” se referă la documente operaționale și constă din următoarele secțiuni:

• scopul programului (informații suficiente pentru a înțelege funcțiile programului și funcționarea acestuia);
• condițiile de execuție a programului (setul minim și/sau maxim de hardware și software etc.);
• execuția programului (o secvență de acțiuni ale operatorului care asigură încărcarea, lansarea, executarea și terminarea programului; descrie funcțiile, formatele și versiunile posibile ale comenzilor cu care operatorul încarcă și controlează execuția programului, precum și răspunsurile programului la aceste comenzi);
• mesaje către operator (texte ale mesajelor transmise operatorului în timpul execuției programului și o descriere a acțiunilor care trebuie întreprinse ca răspuns la aceste mesaje).

Conform acestui GOST, :

• Partea de titlu.
• Partea de informare.

• Parte principală.
• Parte din înregistrarea modificărilor.

A.V.ХХХХХ-ХХ ХХ ХХ-Х

:

• Partea de titlu:
• Partea informativa:
  • adnotare;
  • Cuprins;
• Parte principală:
  • aplicații;
  • modificare partea de jurnal:
  • schimba foaia de inregistrare.

Reguli pentru pregătirea documentației software

Este permisă combinarea anumitor tipuri de documente operaționale (cu excepția listei documentelor operaționale și a formularului). Necesitatea combinarii acestor documente este indicata in specificatiile tehnice. Documentului fuzionat i se atribuie numele și denumirea unuia dintre documentele comasate.

Tipuri de documente de program și conținutul acestora

În partea de sus
GOST 19.103-77 (Desemnarea programelor și a documentelor de program)
Din acest GOST obținem structura desemnării programelor și documentelor programului. Mai jos sunt cele mai importante secțiuni.

Structura desemnării programelor și documentul său de program - specificații:

• Prezentul standard stabilește formele, dimensiunile, locația și procedura de completare a principalelor inscripții ale fișei de aprobare și a paginii de titlu din documentele programului prevăzute de standardele DEUE, indiferent de modalitățile de implementare a acestora.

• Acest standard stabilește cerințe generale pentru executarea documentelor de program pentru calculatoare, complexe și sisteme, indiferent de scopul și domeniul de aplicare al acestora și prevăzute de standardele Sistemului Unificat de Documentare a Programelor (USPD) pentru orice metodă de executare a documentelor pe diverse purtători de date.
• Documentul programului constă din următoarele părți convenționale:
  • titlu;
  • informativ;
  • de bază;
  • înregistrarea modificărilor.
• Secțiunea de copertă constă dintr-o foaie de aprobare și o pagină de titlu. Regulile de întocmire a foii de aprobare și a paginii de titlu sunt stabilite în conformitate cu GOST 19.104-78.
• Partea informativă ar trebui să conțină un rezumat și conținut.
  • Necesitatea includerii părții informaționale în diferitele tipuri de documente de program este stabilită de standardele relevante ale DEUE pentru aceste documente.
  • Adnotarea oferă informații despre scopul documentului și un scurt rezumat al părții sale principale.
  • Conținutul include o listă de înregistrări despre elementele structurale ale părții principale a documentului, fiecare dintre acestea incluzând:
    • desemnarea unui element structural (număr de secțiune, subsecțiune etc.);
    • denumirea elementului structural;
    • adresa elementului structural de pe suportul de stocare (de exemplu, numărul paginii, numărul fișierului etc.).
• Compoziția și structura părții principale a documentului de program sunt stabilite de standardele DEPD pentru documentele relevante.
• Parte din înregistrarea modificărilor (trebuie să fie prezentă în fiecare document de program)
  • Fiecare modificare a documentului programului este înregistrată în această parte în conformitate cu cerințele GOST 19.603-78.

În partea de sus
==================================
GOST 19.106-78* (Cerințe generale pentru documentele de program produse în formă tipărită
cale)
Din acest GOST primim reguli generale pentru metoda tipărită de executare a documentelor programului. Mai jos sunt cele mai importante secțiuni.

• Acest standard stabilește regulile de execuție a documentelor de program pentru calculatoare, complexe și sisteme, indiferent de scopul și domeniul de aplicare al acestora și prevăzute de standardele Sistemului Unificat de Documentare a Programelor (USPD) pentru metoda tipărită de execuție.
• Standardul nu se aplică documentului de program „Textul programului”.
• Compoziția și structura documentului de program sunt stabilite în conformitate cu GOST 19.105-78.
• Documentul program se execută pe o parte a foii, la două intervale; permisă la intervale de unu sau o dată și jumătate.
• Documentele programului sunt intocmite de:
  • pe foi de format A4 (GOST 2.301-68) - la pregătirea unui document prin dactilografiere sau scris de mână (formularul 1). Este permisă desenarea pe coli A3.

• Materialele documentului programului sunt aranjate în următoarea secvență:
  • partea de titlu:
    • fișa de aprobare (nu este inclusă în numărul total de foi ale documentului);
    • pagina de titlu (prima pagină a documentului);
  • partea informativa:
    • adnotare;
    • Cuprins;
  • parte principală:
    • textul documentului (cu imagini, tabele etc.);
    • aplicații;
    • lista de termeni, lista de abrevieri, lista de figuri, lista de tabele, indexul subiectelor, lista documentelor de referinta;
  • modificare partea de jurnal:
    • schimba foaia de inregistrare.

• Rezumatul este plasat pe o pagină separată (numerotată) cu titlul „RESUM” și nu este numerotat ca o secțiune.
  • Adnotarea indică ediția programului și subliniază pe scurt scopul și conținutul documentului. Dacă documentul este format din mai multe părți, numărul total de părți este indicat în adnotare.
• Conținutul documentului este plasat pe o pagină (pagini) separată (numerotată) după adnotare, prevăzută cu titlul „CUPRINS”, nenumerotat ca secțiune și inclus în numărul total de pagini ale documentului.
• Titlurile secțiunilor sunt scrise cu majuscule și plasate simetric față de marginile din dreapta și din stânga textului.
• Titlurile subsecțiunilor sunt scrise din paragraf cu litere mici (cu excepția primei majuscule).
• Nu este permisă separarea cu silabe a cuvintelor din titluri. Nu există punct la sfârșitul titlului.

• Distanța dintre titlu și următorul text, precum și între titlurile de secțiuni și subsecțiuni, trebuie să fie egală cu:
  • la executarea unui document prin dactilografiere - două intervale.
• Pentru secțiunile și subsecțiunile, al căror text este scris pe aceeași pagină cu textul secțiunii anterioare, distanța dintre ultimul rând de text și titlul următor trebuie să fie egală cu:
  • la executarea unui document folosind o metodă dactilografiată - trei intervale dactilografiate.
• Secțiunile, subsecțiunile, paragrafele și subparagrafele trebuie numerotate cu cifre arabe cu un punct.
• În cadrul unei secțiuni trebuie să existe o numerotare continuă pentru toate subsecțiunile, paragrafele și subparagrafele incluse în această secțiune.
• Numerotarea subsecțiunilor include numărul de secțiune și numărul de serie al subsecțiunii incluse în această secțiune, separate printr-un punct (2.1; 3.1 etc.).
• Dacă există secțiuni și subsecțiuni, numărul de serie al clauzei și subclauzei (3.1.1, 3.1.1.1 etc.) se adaugă la numărul subsecțiunii după punct.

• Textul documentului trebuie să fie scurt, clar, excluzând posibilitatea unei interpretări greșite.
• Termenii și definițiile trebuie să fie uniformi și să respecte standardele stabilite, iar în lipsa acestora - general acceptate în literatura științifică și tehnică și să fie menționați în lista de termeni.
• Explicațiile necesare pentru textul documentului pot fi furnizate în note de subsol.
  • O notă de subsol este indicată printr-un număr cu o paranteză plasată la nivelul marginii superioare a fontului, de exemplu: „dispozitiv de imprimare 2) . " sau " lucrarea 5) ".
  • Dacă o notă de subsol se referă la un singur cuvânt, semnul notă de subsol este plasat direct lângă acest cuvânt, dar dacă se referă la o propoziție în ansamblu, atunci la sfârșitul propoziției. Textul notei de subsol este plasat la sfârșitul paginii și separat de textul principal printr-o linie lungă de 3 cm trasată în partea stângă a paginii.
• Ilustrațiile, dacă există mai multe într-un document dat, sunt numerotate cu cifre arabe pe întregul document.
• Formulele dintr-un document, dacă există mai multe dintre ele, sunt numerotate cu cifre arabe; numărul este plasat în partea dreaptă a paginii, între paranteze la nivelul formulei.
• Semnificația simbolurilor și coeficienților numerici incluși în formulă trebuie să fie dată direct sub formulă. Semnificația fiecărui caracter este tipărită pe o nouă linie în ordinea în care sunt date în formulă. Prima linie a transcripției ar trebui să înceapă cu cuvântul „unde”, fără două puncte după el.
• În documentele programului, sunt permise referiri la standarde (cu excepția standardelor de întreprindere), specificații tehnice și alte documente (de exemplu, documente ale organismelor de supraveghere de stat, reguli și reglementări ale Comitetului de stat pentru construcții al URSS). Când se face referire la standarde și specificații tehnice, se indică denumirea acestora.
• Trebuie făcută referire la documentul în ansamblu sau la secțiunile acestuia (indicând denumirea și denumirea documentului, numărul și denumirea secțiunii sau anexei). La repetarea referințelor la o secțiune sau aplicație, este indicat doar numărul.
• Notele la text și tabele indică doar date de referință și explicative.
  • O nota nu este numerotata. După cuvântul „Notă” puneți un punct.
  • Mai multe note trebuie numerotate în ordine, folosind cifre arabe cu punct. După cuvântul „Notă” puneți două puncte.
• Abrevierile cuvintelor din text și inscripțiile de sub ilustrații nu sunt permise.
• Materialul ilustrat, tabele sau textul suport pot fi prezentate sub formă de anexe.
• Fiecare cerere trebuie să înceapă pe o pagină nouă cu cuvântul „ANEXĂ” indicat în colțul din dreapta sus și să aibă un titlu tematic, care este scris simetric față de text cu majuscule.

În partea de sus
==================================
GOST 19.604-78* (Reguli pentru efectuarea de modificări la documentele programului finalizate
în formă tipărită)
Din acest GOST primim reguli generale pentru efectuarea de modificări la documentele programului (ca urmare, pentru a crea un proiect, avem nevoie doar de o foaie de înregistrare a modificării).

• Acest standard stabilește regulile pentru efectuarea modificărilor documentelor de program prevăzute de standardele Sistemului Unificat de Documentare a Programului (USPD) și tipărite.

Datorită cantității semnificative de informații din acest GOST și pentru a economisi spațiu pe această pagină, vă recomand să revizuiți singur GOST 19.604-78*. Puteți vizualiza un exemplu gata făcut al designului unei „fișe de înregistrare a modificării” în orice document al programului furnizat în secțiunea DESCARCARE

Proiectarea programului conform GOST (cum să)

Programele de calculator sunt întocmite în conformitate cu cerințele Sistemului Unificat de Documentare a Programelor (USPD). ESPD este un set de GOST care stabilesc regulile pentru proiectarea, conținutul și structura documentelor programului.
Această instrucțiune conține fragmente din ESPD. Informații complete pot fi obținute direct de la GOST.

Algoritm de proiectare a programului scurt

Pe scurt, algoritmul de proiectare a programului și tipurile de documente ale programului sunt prezentate în figură. Procesul de înregistrare este descris mai detaliat mai jos.

Întocmirea unui document de program

Un document software este un document care conține informații necesare pentru dezvoltarea, producerea, întreținerea și operarea programelor.

Fiecare document de program individual este întocmit în conformitate cu (comune tuturor documentelor ESPD) cerințele GOST 19.101-77, GOST 19.103-77, GOST 19.104-78, GOST 19.105-78, GOST 19.106-78, GOST 19.604-78 ( o descriere mai detaliată a acestor GOST-uri urmează mai jos) și GOST pentru un document de program specific.

Cerințe generale pentru documentele programului. GOST 19.105 - 78

GOST 19.105-78 stabilește cerințe generale pentru pregătirea documentelor programului.

Conform acestui GOST, documentul programului ar trebui să conțină următoarele părți:

• Partea de titlu. Secțiunea de copertă constă dintr-o foaie de aprobare și o pagină de titlu. Regulile de întocmire a fișei de aprobare și a paginii de titlu sunt descrise mai jos.
• Partea de informare. Partea informativă ar trebui să conțină un rezumat și conținut.
  • Adnotarea oferă informații despre scopul documentului și un scurt rezumat al părții sale principale.
  • Conținutul include o listă de înregistrări despre elementele structurale ale părții principale a documentului.

Necesitatea unei părți de informații în diferite tipuri de documente de program este determinată de GOST-urile relevante pentru aceste documente de program.

• Parte principală. Compoziția și structura părții principale a documentului de program sunt stabilite de standardele DEPD pentru documentele relevante.
• Parte din înregistrarea modificărilor.În această parte, se înregistrează fiecare modificare a documentului de program în conformitate cu cerințele GOST 19.603 - 78.

Tipul documentului programului. GOST 19.101 - 77

GOST 19.101-77 stabilește tipuri de programe și documente de programe pentru computere, complexe și sisteme, indiferent de scopul și scopul acestora.

GOST stabilește 2 tipuri de programe:

• Componentă - un program considerat ca un întreg, care îndeplinește o funcție completă și utilizat independent sau ca parte a unui complex;
• Complex - un program format din două sau mai multe componente și (sau) complexe care îndeplinesc funcții interdependente și este utilizat independent sau ca parte a unui alt complex.

GOST determină, de asemenea, tipurile și conținutul documentelor programului.

Desemnarea programelor și documentelor programelor. GOST 19.103 - 77

GOST 19.103-77 stabilește structura desemnării programelor și documentelor de programe pentru calculatoare, complexe și sisteme, indiferent de scopul și domeniul de aplicare al acestora.

Mai simplu spus, acest GOST descrie care ar trebui să fie codul de document al formularului A.V.ХХХХХ-ХХ ХХ ХХ-Х, și ce înseamnă fiecare câmp al acestui cifru.

Inscripții de bază. GOST 19.104 - 78

GOST 19.104-78 stabilește formele, dimensiunile, locația și procedura de completare a principalelor inscripții ale fișei de aprobare și a paginii de titlu în documentele programului prevăzute de standardele DEPD, indiferent de modalitatea de implementare a acestora.

GOST conține exemple de pagină de titlu și o foaie de aprobare, precum și forma generală a foii, împărțită în câmpuri. Puteți vedea și un exemplu.

Cerințe pentru documentele de program tipărite. GOST 19.106 - 78

GOST 19.106-78 stabilește regulile de execuție a documentelor de program pentru metoda de execuție tipărită.

Este important de reținut că acest GOST nu se aplică documentului de program „Textul programului”.

Materialele documentului de program trebuie să fie în următoarea secvență:

• Partea de titlu:
  • fișa de aprobare (nu este inclusă în numărul total de foi ale documentului);
  • pagina de titlu (prima pagină a documentului);
• Partea informativa:
  • adnotare;
  • Cuprins;
• Parte principală:
  • textul documentului (cu imagini, tabele etc.);
  • aplicații;
  • lista de termeni, lista de abrevieri, lista de figuri, lista de tabele, indexul subiectelor, lista documentelor de referinta;
  • modificare partea de jurnal:
  • schimba foaia de inregistrare.

Adnotarea indică ediția programului și subliniază pe scurt scopul și conținutul documentului. Dacă documentul este format din mai multe părți, numărul total de părți este indicat în adnotare. Conținutul documentului este plasat pe o pagină (pagini) separată (numerotată) după adnotare, prevăzută cu titlul „CUPRINS”, nenumerotat ca secțiune și inclus în numărul total de pagini ale documentului.

• Documentul program se execută pe o parte a foii, la două intervale; permisă la intervale de unu sau o dată și jumătate.
• Rezumatul este plasat pe o pagină separată (numerotată) cu titlul „RESUM” și nu este numerotat ca o secțiune.
• Titlurile secțiunilor sunt scrise cu majuscule și plasate simetric față de marginile din dreapta și din stânga textului.
• Titlurile subsecțiunilor sunt scrise din paragraf cu litere mici (cu excepția primei majuscule).
• Nu este permisă separarea cu silabe a cuvintelor din titluri. Nu există punct la sfârșitul titlului.
• Distanța dintre titlu și următorul text, precum și între titlurile de secțiuni și subsecțiuni, trebuie să fie egală cu:
  • la executarea unui document prin dactilografiere - două intervale.
• Pentru secțiunile și subsecțiunile, al căror text este scris pe aceeași pagină cu textul secțiunii anterioare, distanța dintre ultimul rând de text și titlul următor trebuie să fie egală cu:
  • la executarea unui document folosind o metodă dactilografiată - trei intervale dactilografiate.
• Secțiunile, subsecțiunile, paragrafele și subparagrafele trebuie numerotate cu cifre arabe cu un punct.
• În cadrul unei secțiuni trebuie să existe o numerotare continuă pentru toate subsecțiunile, paragrafele și subparagrafele incluse în această secțiune.
• Numerotarea subsecțiunilor include numărul de secțiune și numărul de serie al subsecțiunii incluse în această secțiune, separate printr-un punct (2.1; 3.1 etc.).
• Dacă există secțiuni și subsecțiuni, numărul de serie al clauzei și subclauzei (3.1.1, 3.1.1.1 etc.) se adaugă la numărul subsecțiunii după punct.
• Textul documentului trebuie să fie scurt, clar, excluzând posibilitatea unei interpretări greșite.
• Termenii și definițiile trebuie să fie uniformi și să respecte standardele stabilite, iar în lipsa acestora - general acceptate în literatura științifică și tehnică și să fie menționați în lista de termeni.
• Explicațiile necesare pentru textul documentului pot fi furnizate în note de subsol.
• O notă de subsol este indicată printr-un număr cu o paranteză plasată la nivelul marginii superioare a fontului, de exemplu: „dispozitiv de imprimare2). „ sau „hârtia5)”.
• Dacă o notă de subsol se referă la un singur cuvânt, semnul notă de subsol este plasat direct lângă acest cuvânt, dar dacă se referă la o propoziție în ansamblu, atunci la sfârșitul propoziției. Textul notei de subsol este plasat la sfârșitul paginii și separat de textul principal printr-o linie lungă de 3 cm trasată în partea stângă a paginii.
• Ilustrațiile, dacă există mai multe într-un document dat, sunt numerotate cu cifre arabe pe întregul document.
• Formulele dintr-un document, dacă există mai multe dintre ele, sunt numerotate cu cifre arabe; numărul este plasat în partea dreaptă a paginii, între paranteze la nivelul formulei.
• Semnificația simbolurilor și coeficienților numerici incluși în formulă trebuie să fie dată direct sub formulă. Semnificația fiecărui caracter este tipărită pe o nouă linie în ordinea în care sunt date în formulă. Prima linie a transcripției ar trebui să înceapă cu cuvântul „unde”, fără două puncte după el.
• În documentele programului, sunt permise referiri la standarde (cu excepția standardelor de întreprindere), specificații tehnice și alte documente (de exemplu, documente ale organismelor de supraveghere de stat, reguli și reglementări ale Comitetului de stat pentru construcții al URSS). Când se face referire la standarde și specificații tehnice, se indică denumirea acestora.
• Trebuie făcută referire la documentul în ansamblu sau la secțiunile acestuia (indicând denumirea și denumirea documentului, numărul și denumirea secțiunii sau anexei). La repetarea referințelor la o secțiune sau aplicație, este indicat doar numărul.
• Notele la text și tabele indică doar date de referință și explicative.
• O nota nu este numerotata. După cuvântul „Notă” puneți un punct.
• Mai multe note trebuie numerotate în ordine, folosind cifre arabe cu punct. După cuvântul „Notă” puneți două puncte.
• Abrevierile cuvintelor din text și inscripțiile de sub ilustrații nu sunt permise.
• Materialul ilustrat, tabele sau textul suport pot fi prezentate sub formă de anexe.
• Fiecare cerere trebuie să înceapă pe o pagină nouă cu cuvântul „ANEXĂ” indicat în colțul din dreapta sus și să aibă un titlu tematic, care este scris simetric față de text cu majuscule.

GOST conține o fișă de probă care indică câmpurile, locurile pentru numerotarea paginilor și codul.

Cele mai actuale șabloane ale mele (2016).

Acesta este interesant:

• Ordinul 109/GS La aprobarea setului de reguli „SNiP 3.03.01-87 „Structuri portante și de închidere” Cumpărați Ordinul 109/GS - un document oficial de hârtie cu hologramă și sigilii albastre. mai multe detalii Prețul pentru acest document nu este încă cunoscut. Faceți clic pe butonul „Cumpărați” și plasați o comandă și vă vom trimite [...]
• 1C:Enterprise 8 Configurație standard Contabilitate pentru Kazahstan (de bază), ediția 2.0 Versiunea 2.0.13 Nou în versiunea 2.0.13.5 Actualizare a indicatorilor reglementați de la 1 ianuarie 2014 În conformitate cu Legea Republicii Kazahstan „Cu privire la bugetul republican pentru 2014-2016" de la 1 ianuarie 2014 […]
• Notarul Ippolitova Nina Aleksandrovna în Odintsovo Recenzii ale notarului Ippolitova Nina Aleksandrovna Prin prezenta, în mod liber, din proprie voință și în interes propriu, îmi dau acordul către Media Solutions SRL, cu sediul în str. Tyumen. 50 de ani de VLKSM 19 - 76 (denumit în continuare Operatorul) pentru automate și […]
• 20 Notarii din Novorossiysk Prin prezenta, în mod liber, din proprie voință și în propriul meu interes, îmi dau acordul către Media Solutions LLC, cu sediul în str. Tyumen. 50 de ani de VLKSM 19 - 76 (denumit în continuare Operatorul) pentru prelucrarea automată și neautomatizată a datelor lor personale în conformitate cu […]
• 13 Notarii din Naberezhnye Chelny Prin prezenta, în mod liber, din proprie voință și în propriul meu interes, îmi dau acordul către Media Solutions LLC, cu sediul la Tyumen st. 50 de ani de VLKSM 19 - 76 (denumit în continuare Operatorul) pentru prelucrarea automată și neautomatizată a datelor lor personale în […]
• Fiul procurorului era luminat de un zori palid, Acea veche curte a cimitirului, Iar peste mormântul umed, Un tânar hoț plângea. Iar peste mormântul umed, un tânar hoț a plâns. Biata mea mamă, De ce ai plecat atât de devreme, Nu ți-ai văzut viața, Ai găsit un tată ticălos. Viața ta nu este [...]
• Penalități de soluționare Asigurare auto Litigii locative Litigii funciare Drept administrativ Participarea la construcția comună Litigii familiale Drept civil, Codul civil al Federației Ruse Protecția drepturilor consumatorilor Litigii de muncă, pensii Home Tipuri de penalități: compensare, […]
• Ordin (instrucțiune) privind stimulentele pentru angajați Un ordin privind stimulentele (bonusuri sau premii) pentru angajați este emis de către șeful organizației, iar ordinul este emis de alți funcționari autorizați. Șeful organizației are, de asemenea, dreptul de a solicita stimulente pentru un angajat […]

GOST 19.101-77

Grupa T55

STANDARD INTERSTATAL

Sistem unificat de documentare a programului

TIPURI DE PROGRAME ȘI DOCUMENTE DE PROGRAME

Sistem unificat pentru documentarea programului. Tipuri de programe și documente de program

MKS 35.080

Data introducerii 1980-01-01

Prin Rezoluția Comitetului de Stat de Standarde al Consiliului de Miniștri al URSS din 20 mai 1977 N 1268, data introducerii a fost stabilită la 01/01/80

EDIȚIE (ianuarie 2010) cu Amendamentul nr. 1, aprobat în iunie 1981 (IUS 9-81).


Acest standard stabilește tipurile de programe și documente de programe pentru calculatoare, complexe și sisteme, indiferent de scopul și scopul acestora.

Standardul respectă în totalitate ST SEV 1626-79.

(Ediție schimbată, amendamentul nr. 1).

1. TIPURI DE PROGRAME

1. TIPURI DE PROGRAME

1.1. Programul (conform GOST 19781-90) poate fi identificat și utilizat independent și (sau) ca parte a altor programe.

1.2. Programele sunt împărțite în tipuri prezentate în Tabelul 1.

tabelul 1

1.3. Documentația dezvoltată pentru program poate fi utilizată pentru implementarea și transferul programului pe medii de stocare, precum și pentru fabricarea unui produs software.

1.2, 1.3. (Ediție schimbată, amendamentul nr. 1).

2. TIPURI DE DOCUMENTE DE PROGRAM

2.1. Documentele software includ documente care conțin informații necesare pentru dezvoltarea, producerea, întreținerea și operarea programelor.

2.2. Tipurile de documente ale programului și conținutul acestora sunt prezentate în Tabelul 2.

masa 2

2.3. Tipurile de documente operaționale și conținutul acestora sunt prezentate în Tabelul 3.

Tabelul 3

2.4. În funcție de metoda de implementare și de natura aplicării, documentele programului sunt împărțite în original, duplicat și copie (GOST 2.102-68), destinate dezvoltării, întreținerii și funcționării programului.

2.5. Tipurile de documente de program dezvoltate în diferite etape și codurile acestora sunt prezentate în Tabelul 4.

Tabelul 4

Legendă:

- documentul este obligatoriu;

- documentul este obligatoriu pentru componentele care au utilizare independentă;

- necesitatea întocmirii unui document se determină în stadiul de elaborare și aprobare a specificațiilor tehnice;

- - documentul nu este întocmit.

2,2-2,5. (Ediție schimbată, amendamentul nr. 1).

2.6. Este permisă combinarea anumitor tipuri de documente operaționale (cu excepția listei documentelor operaționale și a formularului). Necesitatea combinarii acestor documente este indicata in specificatiile tehnice. Documentului fuzionat i se atribuie numele și denumirea unuia dintre documentele comasate.

Documentele fuzionate trebuie să specifice informațiile care trebuie incluse în fiecare document care este fuzionat.

2.7. În etapa de elaborare și aprobare a specificațiilor tehnice se determină necesitatea întocmirii specificațiilor tehnice care să cuprindă cerințe pentru producerea, controlul și acceptarea programului.

Specificațiile tehnice sunt elaborate în etapa „Proiectare detaliată”.

2.8. Necesitatea întocmirii specificațiilor tehnice pentru componentele care nu sunt destinate utilizării independente și complexele incluse în alte complexe este determinată de acord cu clientul.

(Introdus suplimentar, amendamentul nr. 1).



Textul documentului electronic
pregătit de Kodeks JSC și verificat cu:
publicație oficială
Sistem software unificat
documentatie: sat. GOST. -
M.: Standartinform, 2010

Aici vreau să mă concentrez pe un singur subiect de care trebuie să se ocupe un programator din întreprinderile autohtone, în special din institutele de cercetare - setul de standarde ESPD. Nu mă consider un mare expert în ESPD - există oameni care lucrează la el de zeci de ani și cu siguranță mă vor corecta. Articolul încearcă mai degrabă să contureze contururile unei „fărți de parcurs” pentru cei care tocmai intră în leagănul lucrurilor.

Standarde

1. internaţional. O trăsătură distinctivă este că a fost adoptat de o organizație internațională. Un exemplu de astfel de organizație este ISO (International Organization for Standardization). Un exemplu al standardului său: ISO 2382-12:1988 (Echipament periferic). Standardele comune ale ISO și ale Comisiei Electrotehnice Internaționale (IEC, în rusă - IEC) sunt larg răspândite: de exemplu, ISO/IEC 12207:2008 (ciclul de viață al software-ului);
2. regional. O trăsătură distinctivă - adoptată de comisia regională de standardizare. De exemplu, multe GOST-uri sovietice sunt acum standarde regionale, deoarece adoptat de consiliul interstatal, care include unele foste republici sovietice. Acest consiliu adoptă, de asemenea, noi standarde - și primesc și desemnarea GOST. Exemplu: GOST 12.4.240-2013;
3. standardele asociațiilor obștești; De exemplu, același IEC: IEC 60255;
4. standardele nationale. Pentru Rusia, începutul unor astfel de standarde este „GOST R”. Pot exista trei tipuri:
   1. copii exacte ale celor internaționale sau regionale. Ele sunt desemnate indistinguit de „scrise singure” (naționale, scrise independent);
   2. copii internaționale sau regionale cu adăugiri. Ele sunt indicate prin adăugarea la cifrul standardului intern a cifrului internațional, care a fost luat ca bază. De exemplu: GOST R ISO/IEC 12207;
   3. de fapt, standarde naționale. De exemplu, GOST R 34.11-94.

Sistemele de notare la fiecare nivel și în fiecare organizație sunt diferite; fiecare caz va trebui analizat separat. Pentru a înțelege rapid „al cui” standard este în fața ochilor tăi, poți folosi o foaie de cheat.

GOST

Dacă cunoașteți denumirea standardului, atunci puteți obține codurile acestuia pentru KGS și OKS, de exemplu, pe acest site web inteligent.
Deci, să revenim la desemnările GOST. Pot exista două opțiuni:

1. standardul se referă la o serie de standarde. În acest caz, după indexul categoriei standard (de exemplu, GOST, GOST R sau GOST RV) există un cod de serie, un punct și denumirea standardului în cadrul seriei. Regulile de desemnare a standardelor în cadrul unei serii sunt stabilite de regulile seriei. De exemplu: GOST RV 15.201-2000, GOST R 22.8.0-99, GOST 19.101-77;
2. Standardul nu aparține unei serii de standarde. Apoi, după indexul categoriei există pur și simplu un număr de serie al standardului, o liniuță și anul adoptării. De exemplu, GOST R 50628-2000.

ESPD

• GOST ESKD (sistem unificat de documentație de proiectare, prefixul „2.”);
• GOST ESTD (sistem unificat de documentare tehnologică, prefixul „3.”);
• GOST R, Sistem de dezvoltare și producție de produse, prefixul „15.”;
• GOST RV, Armament și echipament militar. Sistem de dezvoltare și lansare în producție a produselor, prefixul „15.”;
• GOST, Sistem de documentație tehnică pentru sisteme automate de control, prefixul „24.”;
• GOST, Set de standarde pentru sisteme automate, prefixul „34.”.

19.001-77. Dispoziții generale

19.102-80. Scheme de algoritmi și programe. Reguli de execuție.

19.003-80. Scheme de algoritmi și programe. Simboluri grafice convenționale

19.004-80. Termeni și definiții.

19.005-85. P-scheme de algoritmi și programe

19.101-77. Tipuri de programe și documente de program

19.102-77. Etape de dezvoltare

19.102-77. Etape de dezvoltare

19.103-77. Denumirile programelor și documentelor programelor

19.104-78. Inscripții de bază

• după cum sa menționat deja, adesea o întreprindere nu dorește să dezvăluie informații despre dezvoltator. Separarea LU și „strângerea” permite acest lucru (spre deosebire de ESKD, nu există ștampilă pe foile de document din ESPD; toate informațiile sunt localizate doar în LU);
• Un număr de întreprinderi utilizează un flux mixt de documente: documentele originale sunt stocate electronic în arhiva întreprinderii, iar documentele de pe ele (cu semnături originale) sunt stocate pe hârtie;

19.105-78. Cerințe generale pentru documentele programului

19.106-78. Cerințe generale pentru documentele de program tipărite

• „conținutul documentului include numărul de secțiuni, subsecțiuni, clauze și subclauze care au un titlu” (clauza 2.1.4). Aceasta este o indicație directă că subclauza poate avea un titlu și poate fi inclusă în cuprins;
• „este permisă plasarea textului între titlurile de secțiuni și subsecțiuni, între titlurile de subsecțiuni și paragrafe.” Este important de reținut că textul nenumerotat poate fi doar între titluri și numai pe primele 2 niveluri.

• linie rosie;
• indentarea unui element de structură a documentului după o secțiune (subsecțiune, clauză, subpropoziție);
• element de enumerare.

În acest caz, textul situat pe linia următoare după linia indentată este aliniat la marginea din stânga. Adesea există erori atunci când indentarea sare - linia roșie - o valoare, numărul articolului - noi cu un interval diferit, în indentări imbricate în liste - acest lucru este în general necesar.

În următoarele părți am de gând să ajung la sfârșitul listei de standarde ESPD.

Nume:

Sistem unificat de documentare a programului.

Valabil

Data introducerii:

Data anulării:

Inlocuit de:

Text GOST 19.101-77 Sistem unificat de documentare a programului. Tipuri de programe și documente de program

GOST 19.101-77

STANDARD INTERSTATAL

SISTEM DE DOCUMENTARE SOFTWARE UNIFICAT

TIPURI DE PROGRAME ȘI DOCUMENTE DE PROGRAME

Publicație oficială

Standardinform

UDC 002:651.7/.78:006.354

Grupa T55

STANDARD INTERSTATAL

Sistem unificat de documentare a programului

TIPURI DE PROGRAME ȘI DOCUMENTE DE PROGRAME

Sistem unificat pentru documentarea programului.

Tipuri de programe și documente de program

Prin Decretul Comitetului de Stat de Standarde al Consiliului de Miniștri al URSS din 20 mai 1977 nr. 1268, a fost stabilită data introducerii

Acest standard stabilește tipurile de programe și documente de programe pentru calculatoare, complexe și sisteme, indiferent de scopul și scopul acestora.

Standardul respectă în totalitate ST SEV 1626-79.

(Ediție schimbată, amendamentul nr. 1).

1. TIPURI DE PROGRAME

1.1. Programul (conform GOST 19781-90) poate fi identificat și utilizat independent și (sau) ca parte a altor programe.

1.2. Programele sunt împărțite în tipuri prezentate în tabel. 1.

1.3. Documentația dezvoltată pentru program poate fi utilizată pentru implementarea și transferul programului pe medii de stocare, precum și pentru fabricarea unui produs software.

1.2, 1.3. (Ediție schimbată, amendamentul nr. 1).

2. TIPURI DE DOCUMENTE DE PROGRAM

2.1. Documentele software includ documente care conțin informații necesare pentru dezvoltarea, producerea, întreținerea și operarea programelor.

2.2. Tipurile de documente ale programului și conținutul acestora sunt date în tabel. 2.

Publicație oficială ★

Reproducerea este interzisă

) Editura Standarde, 1977 © STANDARDINFORM, 2010

Ediție (ianuarie 2010) cu Amendamentul nr. 1, aprobat în iunie 1981 (IUS 9-81).

masa 2

2.3. Tipurile de documente operaționale și conținutul acestora sunt date în tabel. 3.

Tabelul 3

document operațional

Lista documentelor operaționale Formular

Descrierea aplicației

Ghidul programatorului Ghidul operatorului

Limba Descriere Manual de service

Lista documentelor operaționale pentru program

Principalele caracteristici ale programului, completitudine și informații despre funcționarea programului

Informații despre scopul programului, domeniul de aplicare, metodele utilizate, clasa de probleme de rezolvat, restricții de utilizare, configurația minimă a hardware-ului

Informații pentru verificarea, asigurarea funcționării și personalizarea programului pentru condițiile unei anumite aplicații

Informații pentru utilizarea programului

Informații pentru a asigura procedura de comunicare între operator și sistemul informatic în timpul execuției programului

Descrierea sintaxei și semanticii limbajului

Informații pentru utilizarea programelor de testare și diagnosticare la întreținerea echipamentelor tehnice

2.4. În funcție de metoda de implementare și de natura aplicării, documentele programului sunt împărțite în original, duplicat și copie (GOST 2.102-68), destinate dezvoltării, întreținerii și funcționării programului.

2.5. Tipurile de documente de program dezvoltate în diferite etape și codurile acestora sunt date în Tabel. 4.

Tabelul 4

Continuarea tabelului 4

Legendă:

Documentul este obligatoriu;

C - un document obligatoriu pentru componentele care au utilizare independentă;

O - necesitatea întocmirii unui document se determină în stadiul de elaborare și aprobare a specificațiilor tehnice;

Documentul nu este întocmit.

2,2-2,5. (Ediție schimbată, amendamentul nr. 1).

2.6. Este permisă combinarea anumitor tipuri de documente operaționale (cu excepția listei documentelor operaționale și a formularului). Necesitatea combinarii acestor documente este indicata in specificatiile tehnice. Documentului fuzionat i se atribuie numele și denumirea unuia dintre documentele comasate.

Documentele fuzionate trebuie să specifice informațiile care trebuie incluse în fiecare document care este fuzionat.

2.7. În etapa de elaborare și aprobare a specificațiilor tehnice se determină necesitatea întocmirii specificațiilor tehnice care să cuprindă cerințe pentru producerea, controlul și acceptarea programului.

Specificațiile tehnice sunt elaborate în etapa „Proiectare detaliată”.

2.8. Necesitatea întocmirii specificațiilor tehnice pentru componentele care nu sunt destinate utilizării independente și complexele incluse în alte complexe este determinată de acord cu clientul.

(Introdus suplimentar, amendamentul nr. 1).

• GOST 19.001-77 Sistem unificat de documentare a programului. Dispoziții generale
• GOST 19.005-85 Sistem unificat de documentare a programului. P-scheme de algoritmi și programe. Denumiri grafice convenționale și reguli de execuție
• GOST 19.101-77 Sistem unificat de documentare a programului. Tipuri de programe și documente de program
• GOST 19.102-77 Sistem unificat de documentare a programului. Etape de dezvoltare
• GOST 19.103-77 Sistem unificat de documentare a programului. Denumirile programelor și documentelor programelor
• GOST 19.104-78 Sistem unificat de documentare a programului. Inscripții de bază
• GOST 19.105-78 Sistem unificat de documentare a programului. Cerințe generale pentru documentele programului
• GOST 19.106-78 Sistem unificat de documentare a programului. Cerințe pentru documentele de program tipărite
• GOST 19.201-78 Sistem unificat de documentare a programului. Sarcina tehnică. Cerințe pentru conținut și design
• GOST 19.202-78 Sistem unificat de documentare a programului. Specificație. Cerințe pentru conținut și design
• GOST 19.301-79 Sistem unificat de documentare a programului. Programul de testare și metodologia. Cerințe pentru conținut și design
• GOST 19.401-78 Sistem unificat de documentare a programului. Textul programului. Cerințe pentru conținut și design
• GOST 19.402-78 Sistem unificat de documentare a programului. Descrierea programului
• GOST 19.403-79 Sistem unificat de documentare a programului. Lista deținătorilor originali
• GOST 19.404-79 Sistem unificat de documentare a programului. Notă explicativă. Cerințe pentru conținut și design
• GOST 19.501-78 Sistem unificat de documentare a programului. Formă. Cerințe pentru conținut și design
• GOST 19.502-78 Sistem unificat de documentare a programului. Descrierea aplicației. Cerințe pentru conținut și design
• GOST 19.503-79 Sistem unificat de documentare a programului. Ghidul programatorului de sistem. Cerințe pentru conținut și design
• GOST 19.504-79 Sistem unificat de documentare a programului. Ghidul programatorului. Cerințe pentru conținut și design
• GOST 19.505-79 Sistem unificat de documentare a programului. Manual de utilizare. Cerințe pentru conținut și design
• GOST 19.506-79 Sistem unificat de documentare a programului. Descrierea limbii. Cerințe pentru conținut și design
• GOST 19.507-79 Sistem unificat de documentare a programului. Lista documentelor operaționale
• GOST 19.508-79 Sistem unificat de documentare a programului. Manual de întreținere. Cerințe pentru conținut și design
• GOST 19.601-78 Sistem unificat de documentare a programului. Reguli generale de duplicare, contabilitate și stocare
• GOST 19.602-78 Sistem unificat de documentare a programului. Reguli pentru duplicarea, contabilizarea și stocarea documentelor de program tipărite
• GOST 19.603-78 Sistem unificat de documentare a programului. Reguli generale pentru efectuarea modificărilor
• GOST 19.604-78 Sistem unificat de documentare a programului. Reguli pentru efectuarea modificărilor documentelor de program tipărite
• GOST 28195-89 Evaluarea calității software-ului. Dispoziții generale
• GOST 34.601-90 Tehnologia informației. Set de standarde pentru sisteme automate. Sisteme automatizate. Etapele creației
• GOST 34.602-89 Tehnologia informației. Set de standarde pentru sisteme automate. Termeni de referință pentru crearea unui sistem automatizat
• GOST R 56447-2015 Gaze, gaze condensate, petrol și gaze și petrol și gaze condensate. Software pentru procesarea și interpretarea datelor seismice. Cerințe funcționale și tehnice de bază
• GOST R 56448-2015 Gaze, gaze condensate, petrol și gaze și petrol și gaze condensate. Software pentru modelarea geologică a zăcămintelor. Cerințe funcționale și tehnice de bază
• GOST R 56450-2015 Gaze, gaze condensate, petrol și gaze și petrol și gaze condensate. Software pentru modelarea hidrodinamică a sistemelor de colectare și tratare a hidrocarburilor. Cerințe funcționale și tehnice de bază
• GOST R 55711-2013 Complex de mijloace tehnice de comunicație radio duplex automatizată HF (HF). Algoritmi de lucru
• GOST R 56566-2015 Tehnologii informaționale. Evaluarea procesului. Partea 9. Profiluri de proces țintă
• GOST R 55692-2013 Module electronice. Metode de compilare și depanare a programelor de testare pentru control automat
• GOST R 56449-2015 Gaze, gaze condensate, petrol și gaze și petrol și gaze condensate. Software pentru modelarea hidrodinamică a câmpurilor. Cerințe funcționale și tehnice de bază
• GOST R 56413-2015 Tehnologii informaţionale. Profiluri europene de locuri de muncă TIC
• GOST R ISO/IEC 15026-1-2016 Inginerie de sistem și software. Garantie sisteme si software. Partea 1. Concepte și vocabular
• GOST R ISO/IEC 15026-4-2016 Inginerie de sistem și software. Garantie sisteme si software. Partea 4. Garanții ciclului de viață
• GOST R 56920-2016 Inginerie de sistem și software. Testare software. Partea 1. Concepte și definiții
• GOST R 56921-2016 Inginerie de sistem și software. Testare software. Partea 2: Procese de testare
• GOST R ISO/IEC 26555-2016 Inginerie de sistem și software. Linia de produse Instrumente și tehnici de management tehnic
• GOST R ISO/IEC 29155-1-2016 Inginerie de sistem și software. Structura analizei comparative a eficacității proiectelor de tehnologie a informației. Partea 1. Concepte și definiții
• GOST R 54360-2011 Sisteme de management al informațiilor de laborator (LIMS). Ghid standard pentru validarea LIMS
• GOST R 54593-2011 Tehnologii informaţionale. Software gratuit. Dispoziții generale
• GOST R ISO/IEC 12207-2010 Tehnologia informației. Inginerie de sistem și software. Procesele ciclului de viață al software-ului
• GOST R 53798-2010 Ghid standard pentru sistemele de management al informațiilor de laborator (LIMS)
• GOST R ISO/IEC 15504-1-2009 Tehnologii informaţionale. Evaluarea procesului. Partea 1: Concept și vocabular
• GOST R ISO/IEC 15504-2-2009 Tehnologia informației. Evaluarea procesului. Partea 2: Realizarea evaluării
• GOST R ISO/IEC 15504-3-2009 Tehnologia informației. Evaluarea procesului. Partea 3: Ghid de evaluare
• GOST R 57098-2016 Inginerie de sistem și software. Managementul ciclului de viață. Ghid de descriere a procesului
• GOST R 57100-2016 Inginerie de sistem și software. Descrierea arhitecturii
• GOST R 57101-2016 Inginerie de sistem și software. Procesele ciclului de viață. Management de proiect
• GOST R 57102-2016 Tehnologii informaționale. Inginerie de sistem și software. Managementul ciclului de viață. Partea 2: Ghid privind aplicarea ISO/IEC 15288
• GOST R 57122-2016 Gaze, gaze condensate, petrol și gaze și petrol și gaze condensate. Software de proiectare a puțurilor. Cerințe funcționale și tehnice de bază
• GOST R 57193-2016 Inginerie de sistem și software. Procesele ciclului de viață al sistemelor
• GOST R ISO/IEC 15504-5-2016 Tehnologii informaționale. Evaluarea procesului. Partea 5: Model de evaluare a procesului ciclului de viață al software-ului
• GOST 34009-2016 Mijloace și sisteme pentru controlul materialului rulant de tracțiune feroviară. Cerințe software
• GOST R 57318-2016 Sisteme de automatizare industrială și integrare. Aplicarea și managementul proceselor de inginerie de sisteme
• GOST R ISO/IEC 25001-2017 Tehnologia informației. Inginerie de sistem și software. Cerințele și evaluarea calității sistemelor și software-ului (SQuaRE). Planificare si management
• GOST R ISO/IEC 33004-2017 Tehnologii informaționale. Evaluarea procesului. Cerințe pentru modele de referință de proces, modele de evaluare a proceselor și modele de maturitate
• GOST R ISO/IEC 15414-2017 Tehnologii informaționale. Deschideți procesarea distribuită. Model de referinta. Limbajul de descriere a întreprinderii
• Limbajul de specificații GOST IEC 60848-2016 GRAFCET pentru diagramele funcționale secvențiale
• GOST R ISO/IEC 25051-2017 Tehnologii informaționale. Inginerie de sistem și software. Cerințele și evaluarea calității sistemelor și software-ului (SQuaRE). Cerințe de calitate și instrucțiuni de testare pentru produsul software gata de utilizare (RUSP).
• GOST R ISO/IEC 33001-2017 Tehnologii informaționale. Evaluarea procesului. Concepte și terminologie
• GOST R ISO/IEC 33002-2017 Tehnologii informaționale. Evaluarea procesului. Cerințe pentru efectuarea unei evaluări a procesului
• GOST R ISO/IEC 33003-2017 Tehnologii informaționale. Evaluarea procesului. Cerințe pentru sistemele de măsurare a proceselor
• GOST R ISO/IEC 33020-2017 Tehnologii informaționale. Evaluarea procesului. Sistem de măsurare a procesului pentru evaluarea capacității procesului
• GOST R 57640-2017 Tehnologii informaționale. Model de referință de proces (RPM) pentru managementul securității informațiilor
• GOST R ISO/IEC 30121-2017 Tehnologii informaționale. Concept pentru gestionarea riscurilor asociate cu examinarea criminalistică a probelor prezentate în formă digitală
• GOST R 58041-2017 Gaze, gaze condensate, petrol și gaze și petrol și gaze condensate. Un sistem de standarde software pentru rezolvarea problemelor de prospectare, explorare și dezvoltare a zăcămintelor. Prevederi de bază și cerințe tehnice
• GOST R 58042-2017 Gaze, gaze condensate, petrol și gaze și petrol și gaze condensate. Cerințe de bază pentru datele inițiale ale sistemelor software pentru rezolvarea problemelor de prospectare, explorare și dezvoltare de domenii
• GOST R ISO/IEC 10746-1-2004 Tehnologia informației. Deschideți procesarea distribuită. Model de bază. Partea 1. Dispoziții de bază
• GOST R ISO/IEC 10746-4-2004 Tehnologia informației. Deschideți procesarea distribuită. Model de bază. Partea 4. Semantică arhitecturală
• GOST R ISO/IEC 12119-2000 Tehnologia informației. Pachete software. Cerințe de calitate și testare
• GOST R ISO/IEC 12207-99 Tehnologia informației. Procesele ciclului de viață al software-ului
• GOST R ISO/IEC 14764-2002 Tehnologia informației. Suport software

Pregatirea documentatiei programului

Specificații tehnice pentru dezvoltarea unui produs software

3.2. Descrierea programului

3.3. Textul programului

Programul de testare și metodologia

3.5. Cerințe pentru documentele de program tipărite

Aplicație. Forma specificațiilor tehnice pentru dezvoltarea unui produs software (produs, model)

Introducere. Informații generale despre Unified System of Program Documentation (USPD).

Sistemul unificat de documentare a programelor este un set de standarde de stat care stabilesc reguli interconectate pentru dezvoltarea, executarea și circulația programelor și a documentației programelor.

Standardele ESPD definesc prevederi generale și standarde fundamentale, reguli de execuție a documentației de dezvoltare, reguli de execuție a documentației de fabricație, reguli de execuție a documentației suport, reguli de execuție a documentației operaționale, reguli de circulație a documentației programului și alte standarde .

ESPD include:

· standarde fundamentale și organizatorice și metodologice;

· standarde care definesc formele și conținutul documentelor de program utilizate în prelucrarea datelor;

· standarde care asigură automatizarea elaborării documentelor programului.

Lista documentelor ESPD include următoarele GOST:

GOST 19.001-77 ESPD. Dispoziții generale.

GOST 19.101-77 ESPD. Tipuri de programe și documente de program (reeditate în noiembrie 1987 cu modificări).

GOST 19.102-77 ESPD. Etape de dezvoltare.

GOST 19.103-77 ESPD. Desemnarea programelor și documentelor programelor.

GOST 19.104-78 ESPD. Inscripții de bază.

GOST 19.105-78 ESPD. Cerințe generale pentru documentele programului.

GOST 19.106-78 ESPD. Cerințe pentru documentele de program tipărite.

GOST 19.201-78 ESPD. Sarcina tehnică. Cerințe pentru conținut și design.

GOST 19.202-78 ESPD. Specificație. Cerințe pentru conținut și design.

GOST 19.301-79 ESPD. Programul de testare și metodologia.

GOST 19.401-78 ESPD. Textul programului. Cerințe pentru conținut și design.

GOST 19.402-78 ESPD. Descrierea programului.

GOST 19.404-79 ESPD. Notă explicativă. Cerințe pentru conținut și design.

GOST 19.501-78 ESPD. Formă. Cerințe pentru conținut și design.

GOST 19.502-78 ESPD. Descrierea aplicației. Cerințe pentru conținut și design.

GOST 19.503-79 ESPD. Ghidul programatorului de sistem. Cerințe pentru conținut și design.

GOST 19.504-79 ESPD. Ghidul programatorului.

GOST 19.505-79 ESPD. Manual de utilizare.

GOST 19.506-79 ESPD. Descrierea limbii.

GOST 19.508-79 ESPD. Manual de întreținere. Cerințe pentru conținut și design.

GOST 19.604-78 ESPD. Reguli pentru efectuarea de modificări la documentele programului executate în tipărire.

GOST 19.701-90 ESPD. Scheme de algoritmi, programe, date și sisteme. Convenții și reguli de executare.

GOST 19.781-90. Software pentru sisteme de procesare a informațiilor.

Alte standarde în domeniul sistemelor software de documentare (PS) includ:

GOST 34.602-89 Tehnologia informației. Set de standarde pentru sisteme automate. Termeni de referință pentru crearea unui sistem automatizat.

GOST 34.601-90 Tehnologia informației. Set de standarde pentru sisteme automate. Sistem automatizat. Etapele creației.

GOST R ISO/IEC TO 12182-2002 Tehnologia informației. Clasificarea software-ului.

GOST R ISO/IEC 12207-99 Tehnologia informației. Procesele ciclului de viață al software-ului.

GOST R ISO/IEC 14764-2002 Tehnologia informației. Întreținerea software-ului.

GOST R ISO/IEC 15026-2002 Tehnologia informației. Nivelurile de integritate ale sistemelor și software-ului.

GOST R ISO/IEC TO 15271-2002 Tehnologia informației. Orientări pentru utilizarea GOST R ISO/IEC 12207-99.

GOST R ISO/IEC 15910-2002 Tehnologia informației. Procesul de creare a documentației utilizatorului software.

Standarde internaționale ISO/IEC:

ISO/IEC 12207:2008 Ingineria sistemelor și a software-ului – Procese ciclului de viață al software-ului.

ISO/IEC 15288:2008 Ingineria sistemelor și a software-ului – Procesele ciclului de viață al sistemului.

IEEE 830-1998 Practică recomandată pentru specificațiile cerințelor software.

Ghid IEEE 1233-1998 pentru dezvoltarea specificațiilor cerințelor de sistem.

Practică recomandată IEEE 1016-1998 pentru descrierile de proiectare software.

ISO/IEC 42010 IEEE Std 1471-2000 Ingineria sistemelor și software-ului – Practică recomandată pentru descrierea arhitecturală a sistemelor intensive în software.

ISO 9001:2000 Sisteme de management al calității – Cerințe.

ISO/IEC 90003:2004 Inginerie software – Linii directoare pentru aplicarea ISO 9001:2000 la software-ul de calculator.

ISO/IEC TR 90005:2008 Inginerie software – Linii directoare pentru aplicarea ISO 9001:2000 la procesele ciclului de viață al sistemului.

ISO/IEC 9126-1:2001 Inginerie software – Calitatea produsului – Partea 1: Model de calitate.

ISO/IEC 9126-2:2003 Inginerie software – Calitatea produsului – Partea 2: Metrici externe.

ISO/IEC 9126-3:2003 Inginerie software – Calitatea produsului – Partea 3: Metrici interne.

ISO/IEC 9126-4:2004 Inginerie software – Calitatea produsului – Partea 4: Calitatea în utilizare.

ISO/IEC 25051:2006 Inginerie software – Cerințe de calitate și evaluare a produsului software (SQuaRE) – Cerințe pentru calitatea produsului software comercial de la raft (COTS) și instrucțiuni pentru testare.

Standardul IEEE 829-1998 pentru documentația de testare a software-ului.

Standardul IEEE 829-2008 pentru documentația de testare a software-ului și a sistemului.

IEEE 1008-1987 (R1993, R2002) Standard pentru testarea unităților software.

ISO/IEC 14598-1:1999 Tehnologia informației – Evaluarea produsului software – Partea 1: Prezentare generală.

ISO/IEC 14598-2:2000 Inginerie software – Evaluarea produsului – Partea 2: Planificare și management.

ISO/IEC 14598-3:2000 Inginerie software – Evaluarea produsului – Partea 3: Proces pentru dezvoltatori.

ISO/IEC 14598-4:1999 Inginerie software – Evaluarea produsului – Partea 4: Proces pentru achizitori.

ISO/IEC 14598-5:1998 Tehnologia informației – Evaluarea produselor software – Partea 5: Proces pentru evaluatori.

ISO/IEC 14598-6:2001 Inginerie software – Evaluarea produsului – Partea 6: Documentarea modulelor de evaluare.

După cum puteți vedea, partea principală a setului de standarde naționale ESPD a fost dezvoltată în anii 70 și 80. Unele dintre aceste standarde sunt depășite din punct de vedere moral și nu sunt lipsite de unele deficiențe: în primul rând, nu reflectă unele tendințe moderne în proiectarea programelor și a documentației programelor, iar în al doilea rând, în aceste standarde există o dublare multiplă a fragmentelor de documentație a programului. Cu toate acestea, în lipsa de ceva mai bun, trebuie să ne concentrăm asupra lor.

Standardele ESPD simplifică procesul de documentare a sistemelor software. Totodată, standardele ESPD, bazate pe cerințele Clientului, permit efectuarea unor modificări la setul de documentație pentru sistemele software, atât în ​​structura, cât și în conținutul tipurilor stabilite de documente software.

În plus, standardele enumerate mai sus sunt de natură consultativă și devin obligatorii pe bază contractuală - i.e. atunci când se face referire la acestea într-un acord pentru dezvoltarea sau furnizarea de software.

Când luați în considerare regulile de compilare a documentației programului, este necesar să aveți în vedere că este recomandabil să prefațați fiecare document cu o introducere.

Introducerea conține cuvinte generale despre relevanță, necesitate și semnificație etc. produs software dezvoltat.