Descrierea structurii logice a exemplului de program. Înregistrarea programului conform GOST (cum se face). Date de intrare și de ieșire

GOST 19.101-77 definește o descriere a programului ca un set de informații despre structura logică și funcționarea programului. Descrierea programului ar trebui să conțină patru părți principale: parte de titlu, parte de informații, parte principală, parte de înregistrare a modificărilor.

Parte principală ar trebui să conțină următoarele secțiuni: informații generale, funcționalitate, descriere structura logica, mijloace tehnice utilizate, apelare și încărcare, date de intrare, date de ieșire.

În funcție de caracteristicile programului, este posibilă introducerea de noi secțiuni sau combinarea secțiunilor individuale. Când descrii produs software conținând mai multe unități de program (programe, subprograme), pentru fiecare unitate de program este dată o descriere conform schemei specificate, cu respectarea ierarhiei de aspect a produsului software global. Deci, de exemplu, dacă totalul Program de control include un apel la funcția FileExist și procedura Brackets, care la rândul său apelează procedura Error și schema generala ierarhia acestui produs software este prezentată în Figura 6, apoi descrierea trebuie să înceapă cu unitatea de program Control, apoi să descrie unitățile de program FileExist, Brackets, Stack, apoi descrie unitatea de program Error ca parte a Parantezelor

Un exemplu de ierarhie a unui produs software complex este prezentat în Figura 6.

Program de control

plasarea parantezelor

în programe


Paranteze FileExist Stack

Procedura de testare Funcția de testare Modul

existența corectă pentru muncă

plasarea parantezelor într-un fișier cu o stivă

Eroare

Procedură InitStack EmptyStack InStack OutStack

Explicaţii Procedură Funcţie Procedură Procedură

erori de inițializare verifica activare extracție

stack void element element stack

a stivui din stivă

Figura 6 – Diagrama structurii programului


În capitolul "Informații generale" denumirea și numele programului, software-ului (mediu de operare, programe de aplicație), necesare pentru funcționarea programului descris. Dacă pentru moduri diferite procesarea necesită programe de aplicație diferite, trebuie dat un tabel care arată ce software este necesar pentru fiecare mod. Trebuie să specificați limbajul de programare în care este scris programul.

În capitolul „Scopul funcțional” se determină clasa de probleme de rezolvat și (sau) scopul programului. Acest paragraf ar trebui să enumere în mod clar toate funcțiile pe care le îndeplinește programul în modul prescris sau la alegerea utilizatorului. Restricțiile privind utilizarea programului trebuie specificate.

În capitolul „Descrierea structurii logice” este furnizată o diagramă structurală a programului, care indică denumirile și scopurile modulelor componente și subrutinelor (Figura 6). O descriere verbală a unităților structurale ale programului este însoțită de o prezentare a diagramelor algoritmice mărite, în general, nu mai mult de trei foi. Prima foaie prezintă o diagramă mărită a algoritmului de funcționare al programului principal. În plus, sunt prezentate diagrame de algoritmi pentru acele subrutine care reflectă esența metodei de rezolvare a problemei. Exemple de diagrame de algoritm sunt prezentate în figurile 7, 8, 9, 10.

Proiectarea diagramelor de algoritm trebuie să respecte cerințele GOST 19.701-90 „Scheme de algoritmi, programe, date și sisteme”. Primul bloc din orice circuit este blocul START (sau START):

Liniile de legătură din diagramă, altfel numite linii de flux, nu trebuie să se intersecteze; pentru aceasta, se folosesc conectori intrapagină


și conectori între pagini

12 [din foaia...

12 [pe foaie...

O săgeată îndreptată către un conector înseamnă că controlul este transferat blocului al cărui număr este indicat în interiorul conectorului. O săgeată îndreptată departe de conector înseamnă că controlul este transferat de la blocul al cărui număr este indicat în interiorul conectorului. Fiecare diagramă de algoritm pentru o unitate de program separată este reprezentată într-o figură separată. Cifrele sunt numerotate consecutiv în cadrul unui document. Fiecare desen are un nume, care este scris deasupra desenului, și un număr, care este scris sub desen. Numele imaginii care ilustrează diagrama algoritmului poate fi numele unității de program corespunzătoare, de exemplu: „Diagrama algoritmului programului de control” sau „Diagrama algoritmului subrutinei Eroare”. Exemple de diagrame de algoritm sunt prezentate în figurile 7, 8, 9, 10.


Figura 8 - Funcția FileExist Figura 9 - Procedura de eroare



Figura 10 – Schema algoritmului procedurii Brackets


Când însoțește un instrument software, descrierea structurii logice este materialul pe care se află acea parte a textului programului care trebuie modificată sau actualizată. Când se descrie logica programului în conformitate cu diagrama algoritmului dată, este necesar să se descrie munca efectuată de fiecare bloc.

În capitolul „Mijloace tehnice utilizate” este necesar să se indice tipurile de computer, configurația complex de calcul, pentru care a fost dezvoltat instrumentul software descris. Dacă programul ține cont de caracteristicile mediului de operare, atunci ar trebui să indicați mediul de operare în care rulează acest program.

sunt specificate metoda de apelare a programului de pe mediul de stocare corespunzător și parametrii de intrare la pornirea programului. Este permisă indicarea volumului programului, informații despre utilizarea operaționale și memorie externa. Este necesar să indicați cum începe efectiv execuția programului, ce mesaje sunt așteptate în această perioadă inițială.

În capitolul "Date de intrare" este necesar să se indice natura, organizarea și pregătirea prealabilă a datelor de intrare. Este necesar să se descrie toate tipurile de date de intrare și scopul fiecărui tip. Dacă informațiile de intrare pot fi reprezentate printr-o succesiune de unități logice mai mari, atunci este necesar să se descrie modalități de combinare a datelor de intrare în aceste unități logice mai mari. Trebuie să specificați formatul și scopul tuturor câmpurilor din înregistrarea de date logice. De asemenea, este necesar să se specifice restricții privind dimensiunea și numărul de date de intrare. Datele de ieșire sunt descrise cu același grad de detaliu ca și datele de intrare. Dacă rezultatul este unul sau mai multe mesaje, atunci este necesar să se indice modul în care utilizatorul ar trebui să interpreteze fiecare mesaj, cum poate utiliza informațiile conținute în fiecare mesaj.

A descrie program, începeți cu o introducere generală. Descrieți principala problemă cu care se confruntă utilizatorul. Desigur, aceasta ar trebui să fie chiar problema pe care programul descris o rezolvă. Apropo asta mod bun conturați imediat publicul țintă al utilizatorilor. Cei care îl consideră util și necesar îl vor descărca sau cumpăra. Alți utilizatori vor economisi timp și nu vor citi mai departe. De asemenea, în introducere, descrieți pe scurt principalele caracteristici ale programului. 1-2 propoziții sunt suficiente pentru asta.

Specifica Cerințe de sistem La echipamente informatice. Pentru a descrie cel mai bine program, faceți o gradație. Enumerați cerințele și cerințele minime pentru lucru confortabil.

Descrieți interfața și spatiu de lucru. A descrie program mai clar, utilizați capturi de ecran ale diferitelor ferestre și stări de lucru. Descrieți principalele bare de instrumente, aspectul elementelor de meniu, barele de stare etc.

Imposibil de descris program, fără a intra în detalii despre principalele sale funcții. Acest lucru se poate face sub forma unei liste sau liste. Cu toate acestea, este important să în acest moment fii specific. De exemplu, expresia „ munca eficienta cu proiecte” nu are nici un sens. Mai exact, există, desigur, o încărcătură semantică, dar este relativă și nu spune cititorului niciun fapt.

După ce ați indicat principalele funcții ale programului, descrieți funcțiile suplimentare ale acestuia, care pot fi deosebit de convenabile și utile pentru utilizator. De exemplu, acestea ar putea fi capacitatea de a se integra rapid cu alt software, îmbunătățiri ale vitezei, elemente de design ușor de utilizat etc.

A descrie program versiune noua, povestește-ne despre schimbările pe care le-a suferit de la ea actualizare anterioară. Descrieți ce funcționalitate a fost eliminată, ce probleme au fost rezolvate, ce a fost nou, ce a fost schimbat, finalizat și îmbunătățit. Diferențele față de versiunile anterioare pot fi prezentate și sub formă de listă.

Faceți o concluzie în care subliniați încă o dată publicul țintă și scopul principal al programului, menționând aspectele câștigătoare ale acestuia.

GOST 19.402-78

Grupa T55

STANDARD INTERSTATAL

Sistem unificat de documentare a programului

DESCRIEREA PROGRAMULUI

Sistem unificat pentru documentarea programului. Descrierea programului.


MKS 35.080

Data introducerii 1980-01-01


Prin Decretul Comitetului de Stat pentru Standarde al URSS din 18 decembrie 1978 N 3350, data implementării a fost stabilită la 01/01/80

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

1. Acest standard stabilește compoziția și cerințele pentru conținutul documentului de program „Descrierea programului”, definit de GOST 19.101-77.

Standardul respectă în totalitate ST SEV 2092-80*.
________________
* Accesul la documentele internaționale și străine menționate aici se poate obține accesând link-ul către site-ul http://shop.cntd.ru. - Nota producătorului bazei de date.

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

2. Structura și designul documentului sunt stabilite în conformitate cu GOST 19.105-78.

Întocmirea părții de informare (adnotări și conținut) este obligatorie.

3. Descrierea programului trebuie să conțină următoarele secțiuni:

Informații generale;

scop funcțional;

descrierea structurii logice;

mijloace tehnice utilizate;

date de intrare;

ieșire.

În funcție de caracteristicile programului, este posibil să intrați secțiuni suplimentare sau combinați secțiuni individuale.

4. În secțiunea „Informații generale” trebuie indicate următoarele:

denumirea și denumirea programului;

software-ul necesar pentru funcționarea programului;

limbaje de programare în care este scris programul.

5. Secțiunea „Scopul funcțional” trebuie să indice clasele de probleme rezolvate și (sau) scopul programului și informații despre restricțiile funcționale ale aplicației.

6. În secțiunea „Descrierea structurii logice” trebuie indicate următoarele:

algoritmul programului;

metodele utilizate;

structura programului cu descrierea funcțiilor componenteși legăturile dintre ele;

conectarea programului cu alte programe.

Descrierea structurii logice a programului se realizează ținând cont de textul programului în limba sursă.

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

7. În secțiunea „Mijloace tehnice utilizate” tipurile de electronice calculatoareși dispozitivele care sunt utilizate la rularea programului.

metoda de apelare a programului de pe mediul de stocare corespunzător;

puncte de intrare în program.

Este permisă indicarea adreselor de descărcare, a informațiilor de utilizare memorie cu acces aleator, volumul programului.

9. În secțiunea „Date de intrare” trebuie să fie indicate următoarele:

caracter, organizare și pregătire prealabilă date de intrare;

format, descriere și metoda de codificare a datelor de intrare.

10. În secțiunea „Date de ieșire” trebuie să fie indicate următoarele:

natura și organizarea datelor de ieșire;

format, descriere și metoda de codificare a datelor de ieșire.

11. Este permisă ilustrarea conținutului secțiunilor cu exemple explicative, tabele, diagrame, grafice.

12. Anexa la descrierea programului poate include diverse materiale care nu sunt adecvate pentru a fi incluse în secțiuni ale descrierii.

7-12. (Introdus suplimentar, amendamentul nr. 1).



Textul documentului electronic
pregătit de Kodeks JSC și verificat cu:
publicație oficială
Sistem unificat de documentare a programului:
Culegere de standarde naționale. -
M.: Standartinform, 2010

Instrucțiuni

A descrie program, începeți cu o introducere generală. Descrieți principala problemă cu care se confruntă utilizatorul. Desigur, aceasta ar trebui să fie chiar problema pe care programul descris o rezolvă. Apropo, aceasta este o modalitate de a contura imediat publicul țintă al utilizatorilor. Cei care îl consideră util și necesar îl vor descărca sau cumpăra. Alți utilizatori vor economisi timp și nu vor mai deranja. De asemenea, în introducere, descrieți principalele caracteristici ale programului. 1-2 propoziții sunt suficiente pentru asta.

Descrieți interfața și spațiul de lucru. A descrie program mai clar, utilizați diferitele ferestre de lucru și . Descrieți principalele bare de instrumente, aspectul elementelor de meniu, barele de stare etc.

Imposibil de descris program, fără a intra în detalii despre principalele sale funcții. Acest lucru se poate face sub forma unei liste sau liste. Cu toate acestea, este important să fii specific în acest moment. De exemplu, expresia „lucrare eficientă cu proiecte” nu are niciun sens semantic. Mai exact, există, desigur, o încărcătură semantică, dar este relativă și nu spune cititorului niciun fapt.

După ce ați indicat principalele funcții ale programului, descrieți funcțiile suplimentare ale acestuia, care pot fi deosebit de convenabile și utile pentru utilizator. De exemplu, acestea ar putea fi capacitatea de a se integra rapid cu alt software, îmbunătățiri ale vitezei, elemente de design ușor de utilizat etc.

A descrie program versiune nouă, spuneți-ne despre modificările pe care le-a suferit de la actualizarea sa anterioară. Descrieți ce funcționalitate a fost eliminată, ce probleme au fost rezolvate, ce a fost nou, ce a fost schimbat, finalizat și îmbunătățit. Diferențele față de versiunile anterioare pot fi prezentate și sub formă de listă.

Fără îndoială, putem spune că publicul țintă este figura cheie a oricărei afaceri, cei pentru care întreaga afacere este efectiv și organizată. Mai simplu spus, aceștia sunt cumpărătorii bunurilor sau serviciilor dvs.

Instrucțiuni

Cheia unei afaceri de succes este acum cunoștințele complete și de încredere despre publicul țintă. Aflați cât mai multe despre clienții dvs. prin macar, răspunde la un anumit minim de întrebări. Mai întâi, aflați sexul publicului țintă.

Faptul este că bărbații și femeile au percepții și valori diferite. Bărbații vor acorda mai multă atenție argumentelor raționale care îi motivează să cumpere, în timp ce femeile sunt mai interesate de componenta emoțională a unui produs sau serviciu. Pentru bărbați, parametri precum statutul, prestigiul, popularitatea mărcii, ușurința în utilizare, service in garantieȘi Servicii aditionale. Femeilor le pasă de siguranță și simplitate, de disponibilitatea reducerilor și a bonusurilor.

În al doilea rând, acordați atenție segmentului de vârstă al publicului țintă. Cu cât clienții dvs. sunt mai în vârstă, cu atât sunt mai solvenți, dar cu atât solicitările lor față de produs sunt mai mari.

Conservatorismul generației mai în vârstă îi va împinge să cumpere un produs pe care îl vor folosi mult timp (până la 5-6 ani). Tinerii sunt deja obișnuiți cu rapidul progres tehnicși îi place să încerce lucruri noi. De regulă, timpul de utilizare a unui produs nou este destul de limitat și variază de la șase luni la doi ani, în funcție de complexitatea și fabricabilitatea produsului.

Efectuați sondaje și acordați atenție unor parametri precum venitul (scăzut, mediu, mare și alte variații), nivelul de educație, componența familiei, mass-media preferată (presă, radio, televiziune, internet), hobby-uri și hobby-uri, timpul petrecut la locul de muncă și pe fugă.

Apoi, adună un focus grup de 10-15 persoane care îndeplinesc parametrii tăi și invită-le să fie primii care testează produse noi și își descriu impresiile. Astfel, puteți corecta erorile în timp util și puteți minimiza pierderile la lansarea unui produs sau serviciu piata mare.

După cum spune proverbul popular, ești întâmpinat de hainele tale, dar scăpat de mintea ta. În general, modul în care se vor dezvolta relațiile ulterioare depinde de prima impresie pe care o facem unui potențial angajator, soț sau echipă de muncă. În ciuda faptului că opinia inițială despre o persoană este adesea înșelătoare, emoțiile sunt depuse la nivel inconștient și schimbarea lor în viitor nu este atât de ușoară, aproape imposibilă.

Instrucțiuni

Sfaturi utile

Totul este bine cu moderație. Încrederea în sine, moderația, înțelegerea clară a obiectivelor pe care doriți să le atingeți, cea mai mare onestitate (dar nu prostia) - aceasta este ceea ce vă va permite, fără a-i înșela pe alții, să găsiți calea cea mai scurtă către scopul dorit.

Cerințele pentru redactarea programelor educaționale în școli au fost elaborate și aprobate în urmă cu 8 ani. De atunci, fiecare profesor este conștient de cum să scrie un plan de activități pentru anul. Dar, în ciuda acestui fapt, profesorii au în mod constant întrebări despre ce anume ar trebui să se reflecte în acest program educațional.

Instrucțiuni

În primul rând, conținutul unui astfel de program trebuie să îndeplinească mai mulți parametri. Ar trebui să abordeze problemele realizărilor mondiale și ale Rusiei, tradițiile țării cuiva și ale altora, iar programul ar trebui să acopere, de asemenea, aspecte legate de caracteristicile culturale și naționale ale regiunilor. Când scrii o lucrare educațională, trebuie să ții cont de vârsta celor cărora le este destinată. La urma urmei, există niște standarde pentru cei mai tineri și altele complet diferite pentru cei mai mari. Este de dorit ca planul de dezvoltare al copiilor pentru anul să includă articole dedicate programelor educaționale suplimentare. De exemplu, aceasta ar putea fi o direcție socio-pedagogică, militar-patriotică, socio-economică și altele. De asemenea, profesorii trebuie să fie moderni și să țină cont de modern tehnologii educaționale(adică, cum ar fi individualitatea copiilor, eficacitatea activităților lor școlare și alte aspecte).

În conținut program educațional nu uitați să descrieți ce condiții au fost create pentru dezvoltarea personalității copilului și modul în care un elev poate crește motivația pentru cunoaștere și creativitate. De asemenea, cadrele didactice trebuie să țină cont și să descrie modul în care vor asigura bunăstarea emoțională a copilului, precum și cum anume plănuiesc să explice și să-i învețe copilului valori universale. La solicitarea Ministerului Rusiei, profesorii trebuie să scrie în program modul în care intenționează să creeze condiții pentru ca un copil să se poată autodetermina atât ca individ, cât și ca profesionist deja în viață.

De asemenea, nu uitați să menționați dezvoltarea fizică elevi și anume: ce clase antrenament fizic vei conduce întâlniri cu ei, în ce ordine și în ce etape poți ține întâlniri cu părinții pentru a discuta cu ei tactici comune de creștere a copilului.

Pe lângă recomandările pentru conținutul intern al programului educațional, există și o serie de cerințe pentru pregătirea unui astfel de document. De exemplu, trebuie să aibă o pagină de titlu, o notă explicativă, un plan educațional și tematic, conținutul cursului studiat, o descriere a materialelor didactice și a cărților folosite pentru învățământul suplimentar. Și, desigur, munca acestui profesor științific ar trebui să se încheie cu o listă de referințe.

Fișierul exe în sistem de operare Windows este fisier executabil programe. Este un cod procesat special, scris de un programator, compilat și convertit într-un tip executabil. Așa că ia un blocnotes și scrie fișier exe, deoarece acest lucru se poate face cu fișiere bat sau inf, este imposibil.

Vei avea nevoie

  • - cunostinte de programare.

Instrucțiuni

Decideți asupra sarcinilor pe care ar trebui să le îndeplinească programul dvs. Dacă acestea sunt sarcini simple (de exemplu), atunci începeți imediat să scrieți un fișier bat. Bole actiuni complexe trebuie descris folosind un limbaj de programare. Ce limbă să alegeți depinde de specificațiile sarcinilor în cauză. Trebuie să aveți cunoștințe standard ale unui limbaj de programare pentru a scrie un mic program pentru a îndeplini orice sarcini specifice.

După ce ați ales un limbaj de programare, învățați elementele de bază ale scrierii codului limba dată. Instalați un mediu de dezvoltare și încercați să scrieți programe simple. După ce înțelegeți logica mediului și a compilatorului, puteți începe să implementați sarcinile atribuite.

După ce ați scris programul, compilați fișierele codul programului la aplicația executabilă prin adăugare bibliotecile necesareși resurse. Verificați rezultatul pe propriul computer și apoi pe un computer tester pentru a exclude erori neașteptate. De regulă, puteți utiliza un compilator de mediu standard. Există, de asemenea, un software special care vă permite să compilați diverse programe

V.E. Karpov

Acest document conţine scurta descriere Standardele ESPD, a căror cunoaștere este necesară pentru înscrierea studenților cursuriși proiecte legate de crearea de sisteme software. În plus, poate fi util din punctul de vedere al îmbunătățirii calității documentației software în general.

SPECIFICAȚII TEHNICE (GOST 19.201-78)

1. Dispoziții generale

ETAPE DE DEZVOLTARE (GOST 19.102-77)

DESCRIEREA PROGRAMULUI (GOST 19.402-78)

TEXTUL PROGRAMULUI (GOST 19.401-78)

PROGRAM ȘI METODOLOGIA DE TESTARE (GOST 19.301-79)

CERINȚE PENTRU DOCUMENTELE SOFTWARE TIPARATE (GOST 19.106-78)

Standardizare în domeniul documentației software

Cum să mergi înainte

Pregătirea documentației pentru software (PS) în conformitate cu GOST-urile existente

2. Caracteristicile generale ale stării

2.3. Standardele de stat ale Federației Ruse (GOST R)

2.4. Standardul internațional ISO/IEC 12207: 1995-08-01

Poate cea mai neplăcută și dificilă etapă a activității de programare este crearea documentației programului. Din păcate, de obicei acest lucru fie nu este predat deloc, fie, în cel mai bun caz, nu acordă atenția cuvenită calității documentelor primite. Cu toate acestea, stăpânirea acestei arte este adesea una dintre cel mai important factor, care determină calitatea unui programator.

În primul rând, capacitatea de a crea documentația programului determină nivelul profesional al programatorului. Clientul nu se va adânci în complexitățile și caracteristicile celui mai minunat program. Clientul va citi mai întâi documentația. Factorul psihologic joacă, de asemenea, un rol important în acest sens. În special, fosta școală sovietică de programare a fost (și este acum) apreciată în întreaga lume. Programatorii autohtoni moderni au încetat să fie citați. Clasa nu este aceeași. În zilele noastre programele nu mai sunt scrise, ci compilate (și acestea sunt „două mari diferente„). Deci, un pachet de documentație software (denumit în continuare PD) creat în stil „clasic” va crea cea mai favorabilă impresie asupra clientului sau angajatorului dumneavoastră. Mai mult, dacă autorul PD evită expresii precum „click pe scrollbar. ..” , „șurub”, etc. Din nefericire, o astfel de vorbărie asemănătoare jargonului ascunde de obicei fie o lipsă de gânduri, fie un gol complet (autorul a rămas cu o impresie de neșters de povestea unuia dintre cunoscuții săi despre un anume „jucător” care a fost cu cineva sau a „conversat”, sau a fost angajat în „moderare” sau ceva de genul asta.) Limbajul PD este un fel de limbaj birocratic, foarte conservator. Are propriul său farmec aparte. Fiți de acord că termenii HDD, HDD, manipulatorul manual de tip „mouse” (sau „kolobok”, așa cum era scris într-unul dintre vechile pachete PD) sună complet diferit de „șurubul”, „flop” și pur și simplu „mouse” corespunzătoare. Apropo, lucrurile au deja a ajuns la punctul în care, spun ei, chiar și o specialitate specială este un scriitor tehnic, adică o persoană care știe să creeze documentație software.

În al doilea rând, un pachet PD bine conceput (mai precis, creat) vă va scuti de multe necazuri. În special, puteți scăpa de întrebările enervante și de afirmațiile nefondate prin simpla trimitere a utilizatorului la documentație. Acesta se referă, în primul rând, la cel mai important document - Termenii de referință. Vom vorbi despre asta mai jos, dar acum vă putem aminti de procesul de mai multe milioane de dolari împotriva IBM. Acest proces a fost intentat de o editura mare, nemultumita de calitatea VT si software. IBM a câștigat cazul. Și a câștigat doar pentru că a prezentat Termenii de Referință semnat de ambele părți. Acest lucru s-a întâmplat cu mult timp în urmă, în anii 70, dar asta nu schimbă esența problemei.

Inca un lucru. Este important să creați primul pachet PD. Acest lucru va fi suficient pentru a construi toate cele ulterioare pe baza sa, folosindu-l ca model sau șablon. Dar acest lucru trebuie făcut foarte eficient. Pe îndelete. Foarte temeinic.

Mai întâi trebuie să vă înarmați cu standardele GOST. GOST definește totul. În special, include Sistemul Unificat de Documentare a Programelor (USPD) care ne interesează. Poate cel mai dificil lucru este să obțineți GOST-ul în sine. GOST ar trebui să fie numai în formă originală tipărită. Sunt vândute (cel puțin când era) în magazine speciale. În special, pentru a obține standarde în domeniul documentației, puteți contacta următoarele organizații:

  • IPK „Standarde de publicare”, Departamentul teritorial de distribuție al NTD (magazinul „Standarde”), 17961, Moscova, st. Donskaya, 8, tel. 236-50-34, 237-00-02, fax/tel. 236-34-48 (privind GOST și GOST R).
  • VNIIKI Gosstandart al Rusiei (sala de lectură), 103001, Moscova, Granatny per. nr.4, tel. 290-50-94 (privind standarde internaționale, străine și alte documentații științifice și tehnice).

Și fără citate sau surse secundare. GOST este legea. Și cu atât mai mult, fără internet (imaginați-vă că o instanță pronunță o sentință folosind o imprimare a Codului penal descărcată de pe un site web). Nu ai încredere în nimeni altul decât originalul. Totuși, autorul va trebui apoi să recurgă la citarea DUAE, abdicând astfel orice responsabilitate.

Să începem cu prevederile generale despre Sistemul Unificat de Documentare a Programului (care sunt, de asemenea, definite în standardul corespunzător GOST 19.001-77).

Sistem unificat de documentare a programului - complex standardele de stat, stabilirea regulilor interconectate pentru dezvoltarea, proiectarea ș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 documentatie operationala, reguli de circulație a documentației software și alte standarde. ESPD include:

  • standarde fundamentale și organizatorice și metodologice;
  • standarde care definesc formele și conținutul documentelor program utilizate în prelucrarea datelor;
  • standarde care asigură automatizarea elaborării documentelor programului.

În general, lista documentelor DEPD este foarte extinsă. În special, include următoarele GOST-uri:

  • 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. Ghid î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.

După cum puteți vedea, partea principală a complexului ESPD a fost dezvoltată în anii 70 și 80. Unele dintre aceste standarde sunt depășite și nu sunt lipsite de unele dezavantaje. În primul rând, ele nu reflectă unele tendințe moderne în proiectarea programelor și a documentației programului și, în al doilea rând, aceste standarde conțin duplicarea multiplă a fragmentelor de documentație a programului. Cu toate acestea, în lipsa de ceva mai bun, trebuie să ne concentrăm asupra lor.

Deci, standardele ESPD simplifică procesul de documentare a sistemelor software. Totuși, în primul rând, alcătuirea documentelor de program prevăzută de standardele DEPD nu este deloc atât de „rigidă” pe cât ar părea: standardele permit includerea documentației privind sistem software(PS) tipuri suplimentareși, în al doilea rând, pe baza cerințelor clienților, unele modificări atât în ​​structură, cât și în conținut sunt acceptabile specii stabilite PD. Mai mult, se poate observa că standardele ESPD (și acest lucru se aplică tuturor celorlalte standarde din domeniul PS - GOST 34, standardul internațional ISO/IEC etc.) sunt de natură consultativă. Faptul este că, în conformitate cu Legea Federației Ruse „Cu privire la standardizare”, aceste standarde devin obligatorii pe bază contractuală - adică. când se face referire la acestea în contractul de dezvoltare (furnizare) a software-ului.

Înainte de a începe să luăm în considerare regulile de compilare a documentației software, este necesar să facem următoarea remarcă. Este recomandabil să prefațați fiecare document cu o introducere. Introducerea vorbește în general. Despre relevanță, necesitate etc. Scopul interpretului aici este să arate semnificația și necesitatea efectuării acestei lucrări. Începutul este de obicei standard: „Nenumăratele sisteme existente în prezent... ... deschid perspective reale în...”, etc. Aici se introduc de obicei citate din discursurile diferitelor figuri (acesta este un aspect pur psihologic): „... așa cum s-a spus la ultimul plen, congres, conferință etc.). Puteți începe cu faptul că „.. Astăzi, în era transformărilor socio-economice indigene... etc.” În general, principalul lucru aici este să nu exagerezi.

Și mai departe. Când își descrie produsul, dezvoltatorul confundă adesea conceptele de componentă și complex. Acest - tipuri diferite programe. O componentă este definită ca „un program considerat ca un întreg unic, care îndeplinește o funcție completă și utilizat independent sau ca parte a unui complex”, iar un complex este „un program format din două sau mai multe componente și (sau) complexe care funcționează interconectate. funcții și este utilizat independent sau ca parte a unui alt complex.”

Conform GOST, acest standard (reeditat în noiembrie 1987) stabilește procedura de construire și pregătire a specificațiilor tehnice pentru dezvoltarea unui program sau produs software pentru calculatoare, complexe și sisteme, indiferent de scopul și scopul acestora.

Trebuie să fii extrem de atent și atent când îl creezi, pentru că... Adesea, o specificație tehnică elaborată cu pricepere (și competent) determină succesul întregii lucrări. Specificațiile tehnice sunt convenite cu Clientul, care de obicei se străduiește să introducă cât mai multe cerințe contradictorii și umflate. Sarcina Executorului este, dimpotrivă, să-i ușureze viața. Dar după ce semnăturile au fost plasate pe ambele părți, este prea târziu pentru a reda ceva.

Caietul de sarcini se întocmește pe foi de format A4 și/sau A3, de regulă, fără a se completa câmpurile foii. Numerele foii (paginii) sunt plasate în partea de sus a foii, deasupra textului.

Pentru a face modificări și completări la fundalul tehnic în etapele ulterioare de dezvoltare a unui program sau a unui produs software, se eliberează o completare la acesta. Coordonarea și aprobarea adăugării la specificatii tehnice efectuate în aceeași ordine ca cea stabilită pentru specificațiile tehnice.

Termenii de referință trebuie să conțină următoarele secțiuni:

  • denumirea și domeniul de aplicare;
  • baza de dezvoltare;
  • scopul dezvoltării;
  • cerințe tehnice pentru un program sau un produs software;
  • stadii și stadii de dezvoltare;
  • procedura de control si acceptare;
  • aplicatii.

În funcție de caracteristicile programului sau produsului software, este posibil să clarificați conținutul secțiunilor, să introduceți noi secțiuni sau să le combinați pe cele individuale.

În capitolul Numele și domeniul de aplicare indica numele, descriere scurta domeniul de aplicare al programului sau produsului software și obiectul în care este utilizat programul sau produsul software.

În capitolul Baza dezvoltării trebuie indicat:

  • document(e) pe baza căruia se realizează dezvoltarea;
  • organizația care a aprobat acest document și data aprobării acestuia;
  • nume și (sau) simbol teme de dezvoltare.

În raport cu specificul proces educațional baza poate fi o misiune pentru proiectarea cursului, ordin pentru institut din data de __.__. pentru N ___., contract __.__. pentru N ___. , și așa mai departe.

În capitolul Scopul dezvoltării Trebuie indicat scopul funcțional și operațional al programului sau produsului software. Vă puteți limita aici la una sau două fraze. Principalul lucru este să definiți clar pentru ce este acest program.

De exemplu: programul este nucleul unei stații de lucru automatizate (AWS) pentru un dezvoltator de continuu sisteme liniare control automat (ACS), permițând utilizatorului să rezolve problemele de analiză a modelelor simple.

Capitol Cerinte tehnice la un program sau produs software ar trebui să conțină următoarele subsecțiuni:

  • cerințe pentru a caracteristici functionale;
  • cerințe de fiabilitate;
  • termeni de utilizare;
  • cerințe pentru compoziție și parametri mijloace tehnice;
  • cerințe pentru informații și compatibilitate software;
  • cerințe de etichetare și ambalare;
  • cerințe pentru transport și depozitare;
  • cerinte speciale.

Cu alte cuvinte, de aici încep specificul. Descrie ce ar trebui să facă programul și cum ar trebui să arate.

Cerințe pentru caracteristicile funcționale. Aici trebuie indicate cerințele pentru compoziția funcțiilor îndeplinite, organizarea datelor de intrare și de ieșire, caracteristicile de sincronizare etc.

De exemplu: programul ar trebui să permită ... să calculeze ... să construiască ... să creeze ...

Date inițiale: fisier text cu un dat...

Date de ieșire: informații grafice și text - rezultatele analizei sistemului...; fișiere text - rapoarte despre ... diagnostice ale stării sistemului și mesaje despre toate erorile care au apărut.

Cerințe de fiabilitate. Trebuie specificate cerințele pentru asigurarea funcționării fiabile (asigurarea funcționării stabile, monitorizarea informațiilor de intrare și ieșire, timpul de recuperare după o defecțiune etc.).

Este dificil să „ghicim” ceva aici. Cel mai bun scenariu este că programul dumneavoastră funcționează numai cu date absolut corecte. De obicei, Clientul nu este de acord cu acest lucru, dar puteți încerca.

De exemplu: Programul trebuie să funcționeze cu o anumită matrice extinsă de incidente ale graficului studiat în conformitate cu algoritmul de operare, să genereze mesaje de eroare atunci când datele inițiale sunt specificate incorect și să suporte un mod interactiv în cadrul capabilităților oferite utilizatorului.

Termeni de utilizare. Trebuie indicate conditiile de functionare (temperatura mediului ambiant, umiditate relativa etc. pentru tipurile de medii de stocare selectate) in care trebuie asigurate caracteristicile specificate, precum si tipul de serviciu, numarul necesar si calificarea personalului.

De obicei, nu există dificultăți cu acest punct. Din pacate, clauza despre profesionalismul utilizatorului de catre Client este neaparat implicata. Acesta, desigur, este un alt motiv pentru a găsi defecte în programul dvs. Cu toate acestea, aici ne putem limita la expresii precum „Condițiile de operare ale programului coincid cu condițiile de funcționare ale PC-ului IBM și ale PC-urilor compatibile”, „Programul ar trebui să fie proiectat pentru un utilizator neprofesionist”. și așa mai departe.

Cerințe pentru compoziția și parametrii mijloacelor tehnice. Indicați compoziția necesară a mijloacelor tehnice cu indicarea caracteristicilor tehnice ale acestora.

Principalul lucru aici este să nu uiți nimic și să asigurăm totul, pe de o parte (altfel se vor strecura într-un fel de IBM PC/XT cu afișaj monocromși fără mouse) și, pe de altă parte, nu exagerați cu cerințe crescute, altfel Clientul va găsi un Antreprenor mai flexibil.

De exemplu: Trebuie să aveți un PC IBM - un PC compatibil cu adaptor grafic EGA (VGA). Necesar spatiu pe disc- cel puțin 600 KB, cantitatea de RAM liberă - cel puțin 400 KB. Este de dorit să aveți un driver EMS și un manipulator de tip mouse.

Cerințe pentru informații și compatibilitate software. Caracteristicile sunt aceleași ca în paragraful anterior. Aici trebuie specificate cerințele pentru structurile de informații la intrare și ieșire și metodele de soluție, codurile sursă și limbaje de programare. Acolo unde este necesar, trebuie asigurată protecția informațiilor și a programelor.

De exemplu: Programul trebuie să funcționeze autonom sub versiunea OS MS DOS nu mai mică de 3.3. Limbajul de bază programare - Turbo Pascal 6.0.

Cerințele de etichetare și ambalare și cerințele de transport și depozitare sunt destul de exotice. În general, aceasta indică cerințele pentru etichetarea unui produs software, opțiunile și metodele de ambalare. Iar cerințele de transport și depozitare trebuie să indice pentru produsul software condiții de transport, locații de depozitare, condiții de depozitare, condiții de depozitare, perioade de depozitare în diferite condiții.

Cerințele speciale sunt un lucru foarte important. Este mai bine să le evitați dacă este posibil. Și declară-o imediat.

De exemplu: Nu există cerințe speciale pentru caracteristicile de sincronizare ale programului. Nu există cerințe speciale pentru caracteristicile capacitive ale programului.

Indicatori tehnico-economici. Acest punct cel mai dificil pentru un programator nu este întotdeauna acolo. Este necesar în primul rând atunci când scopul tău este să justifice eficacitatea și importanța enormă a muncii efectuate. Acest articol funcționează de obicei foarte bine pentru client. Cel puțin, aceasta este cea mai bună justificare pentru momentul și sumele monetare ale dezvoltării.

Această secțiune ar trebui să indice: eficiența economică estimată, necesarul anual estimat (de exemplu: numărul așteptat de apeluri către complex în ansamblu - 365 de sesiuni de lucru), avantajele economice ale dezvoltării în comparație cu cele mai bune eșantioane interne și străine sau analogi.

În plus, este recomandabil să se ofere o definiție atât a costului estimat al dezvoltării programului, cât și o definiție a complexității programării.

Etape și stadii de dezvoltare(acesta va fi discutat mai detaliat mai jos) stabiliți etapele necesare de dezvoltare, etapele și conținutul lucrărilor (o listă de documente de program care trebuie elaborate, convenite și aprobate), precum și, de regulă, termenele de dezvoltare și determina executantii.

Pașii standard sunt descriși aici. Principalul lucru este să determinați corect momentul. Dacă este posibil, încercați să distribuiți în mod egal etapele pe termene limită (și sume). Amintiți-vă că nu toate proiectele ajung la etapa finală. Și ar trebui să existe rapoarte pentru fiecare etapă. Amintiți-vă, de asemenea, că proiectul de lucru va dura cel mai mult timp. Dacă nu aveți timp să completați documentația la timp, Clientul are fiecare drept nu accepta deloc slujba cu toate consecințele care decurg.

Etapele și fazele principale și indispensabile sunt termenii de referință în sine, proiectul preliminar, proiectele tehnice și de lucru.

  • Proiectare preliminară. În această etapă, structurile datelor de intrare și de ieșire sunt dezvoltate în detaliu și se determină forma de prezentare a acestora. O descriere generală a algoritmului, algoritmul în sine și structura programului sunt în curs de dezvoltare. Se elaborează un plan de acțiune pentru dezvoltarea și implementarea programului.
  • Proiect tehnic. Conține un algoritm dezvoltat pentru rezolvarea problemei, precum și metode de monitorizare a informațiilor inițiale. Aici sunt dezvoltate instrumente pentru procesarea erorilor și emiterea mesajelor de diagnosticare, se determină formulare pentru prezentarea datelor inițiale și configurația echipamentelor tehnice.
  • Proiect de lucru. În această etapă, se efectuează programarea și depanarea programului, dezvoltarea documentelor programului, a programelor și a metodelor de testare. Se pregătesc exemple de testare și depanare. Documentația și materialul grafic sunt finalizate. De obicei, se precizează că în timpul dezvoltării programului trebuie pregătită următoarea documentație:
    • textul programului;
    • descrierea programului;
    • programul de testare și metodologia;
    • descrierea aplicației;
    • manualul utilizatorului.

Acestea sunt cerințe standard. Dacă Clientul este de acord că nu toată această listă poate fi prezentată, atunci aceasta înseamnă că intențiile sale față de dvs. și de produsul dvs. nu sunt serioase.

Este posibil să nu existe niciun material grafic. Mai ales când nu vei raporta rezultatele muncii tale. Dar pentru proiecte serioase acest articol este necesar.

De exemplu: În timpul dezvoltării programului, trebuie pregătit următorul material grafic:

    • indicatori tehnico-economici;
    • structura programului;
    • format pentru prezentarea datelor de intrare în program;
    • diagrama algoritmului general (2 foi);
    • algoritmi de calcul de bază;
    • exemplu de funcționare a programului.

În capitolul Procedura de control si acceptare trebuie precizate tipurile de încercări şi Cerințe generale pentru acceptarea muncii. Dacă este posibil, atunci în acest paragraf indicați că „controlul și acceptarea dezvoltării se realizează folosind echipamente furnizate de Client”, altfel vi se poate solicita să aduceți echipamentul cu dvs.

De exemplu: Controlul și acceptarea dezvoltării sunt efectuate pe baza testelor de testare și a exemplelor de depanare. Aceasta verifică execuția tuturor funcțiilor programului.

ÎN Aplicații Dacă este necesar, specificațiile tehnice sunt furnizate de:

  • o listă de cercetări și alte lucrări care justifică dezvoltarea;
  • diagrame de algoritm, tabele, descrieri, justificări, calcule și alte documente care pot fi utilizate în timpul dezvoltării;
  • alte surse de dezvoltare.

Acest standard stabilește etapele de dezvoltare a programelor, documentația programului, precum și etapele și conținutul muncii:

Etape de dezvoltare

Etapele muncii

Sarcina tehnică

Justificarea necesității dezvoltării programului

Formularea problemei.
Colectarea materialelor sursă.
Selectarea și justificarea criteriilor pentru eficacitatea și calitatea programului dezvoltat.
Justificarea necesității lucrărilor de cercetare.

Muncă de cercetare

Determinarea structurii datelor de intrare și de ieșire.
Selecția preliminară a metodelor de rezolvare a problemelor.
Justificarea fezabilității utilizării programelor dezvoltate anterior.
Determinarea cerinţelor pentru mijloace tehnice.
Justificarea posibilității fundamentale de rezolvare a problemei.

Elaborarea și aprobarea specificațiilor tehnice

Determinarea cerințelor programului.
Elaborarea unui studiu de fezabilitate pentru dezvoltarea programului.
Determinarea etapelor, etapelor și calendarului de desfășurare a programului și documentația pentru acesta.
Alegerea limbajelor de programare.
Determinarea necesității lucrărilor de cercetare în etapele ulterioare.
Coordonarea si aprobarea specificatiilor tehnice.

Proiectare preliminară

Elaborarea unui proiect preliminar

Dezvoltarea preliminară a structurii datelor de intrare și de ieșire.
Clarificarea metodelor de rezolvare a problemei.
Elaborarea unei descrieri generale a algoritmului de rezolvare a problemei.
Elaborarea unui studiu de fezabilitate.

Aprobarea anteproiectului


Coordonarea si aprobarea proiectului preliminar

Proiect tehnic

Dezvoltarea proiectului tehnic

Clarificarea structurii datelor de intrare și de ieșire.
Dezvoltarea unui algoritm pentru rezolvarea problemei.
Determinarea formei de prezentare a datelor de intrare și de ieșire.
Definiția semanticii și sintaxei limbajului.
Dezvoltarea structurii programului.
Determinarea finală a configurației hardware.

Aprobarea proiectării tehnice

Elaborarea unui plan de acțiune pentru dezvoltarea și implementarea programelor.
Elaborarea unei note explicative.
Coordonarea si aprobarea proiectului tehnic.

Proiect de lucru

Dezvoltarea programelor

Programare și depanare

Dezvoltarea documentației software

Dezvoltarea documentelor programului în conformitate cu cerințele GOST 19.101-77.

Testarea programului

Elaborarea, coordonarea și aprobarea programului și metodologiei de testare.
Efectuarea de teste preliminare de stat, interdepartamentale, de acceptare și alte tipuri de teste.
Corectarea programului și a documentației programului pe baza rezultatelor testelor.

Implementarea

Intocmirea si transmiterea programului

Pregătirea și transferul de programe și documentație software pentru întreținere și (sau) producție.
Înregistrarea și aprobarea actului de transfer al programului pentru întreținere și (sau) producție.
Transferul programului în fondul de algoritmi și programe.

Note:

  1. Este permisă excluderea celei de-a doua etape de dezvoltare, iar în cazuri justificate tehnic - a doua și a treia etapă. Necesitatea acestor etape este indicată în specificațiile tehnice.
  2. Este permisă combinarea, excluderea etapelor de lucru și (sau) conținutului acestora, precum și introducerea altor etape de lucru, așa cum sa convenit cu clientul.

Acest standard se concentrează pe documentarea produsului de dezvoltare rezultat.

Strict vorbind, sunt două diferite documente care au însă multe în comun. Aceasta este o DESCRIERE GENERALĂ (GOST 19.502-78) și o DESCRIERE A PROGRAMULUI (GOST 19.402-78). Cu toate acestea, din cauza faptului că este foarte dificil să le creați efectiv pe ambele cu o calitate înaltă, fără a recurge la duplicarea aproape completă și ruperea pieselor, ar fi suficient să implementați un document, mai general, „hibrid”. Să-i spunem „Descrierea programului”.

De fapt, „Descrierea programului” în conținutul său poate fi completată cu secțiuni și paragrafe preluate din standardele pentru alte documente și manuale descriptive: GOST 19.404-79 ESPD. Notă explicativă, GOST 19.503-79 ESPD. Ghidul programatorului de sistem, GOST 19.504-79 ESPD. Ghidul programatorului, GOST 19.505-79 ESPD. Manual de utilizare etc. În special, din Nota explicativă puteți lua o diagramă a algoritmului, o descriere generală a algoritmului și (sau) funcționarea programului, precum și justificarea deciziilor tehnico-tehnico-economice adoptate.

Descrierea programului trebuie să includă o parte informativă - adnotare și conținut.

Partea principală a documentului ar trebui să conțină o parte introductivă și următoarele secțiuni:

  • scop funcțional;
  • descrierea logicii.
  • Condiții de utilizare;
  • compoziție și funcții.

În funcție de specificul programului, pot fi introduse secțiuni suplimentare.

ÎN Parte introductivă Documentul oferă informații generale despre program - numele complet, denumirea, posibilele aplicații ale acestuia etc.

De exemplu: Programul „Stație de lucru automatizată pentru dezvoltator de arme autopropulsate” este destinat pentru... implementat pe.... Programul sprijină...

În capitolul Scop indicați scopul programului și furnizați o descriere generală a funcționării programului, caracteristicile sale principale, informații despre restricțiile impuse domeniului de aplicare al programului și, de asemenea, indicați tipurile de computere și dispozitive electronice care sunt utilizate în timpul funcționării.

De exemplu: Programul este conceput pentru a rezolva probleme... Programul reprezintă nucleul unei stații de lucru automatizate...

Utilizatorul are posibilitatea de a..., implementa..., rula..., analiza..., obține rezultate de analiză și procesare..., construi... etc.

la capitolul " Descrierea logicii" indica:

  • descrierea structurii programului și a părților sale principale

(de exemplu: programul include următoarele:

  • interfața cu utilizatorul,
  • modul pentru determinarea traseelor ​​într-un grafic,
  • modul de calcul al funcției de transfer,
  • modul pentru construirea caracteristicilor de amplitudine și frecvență de fază,
  • modul pentru construirea unui răspuns la o influență polinomială,
  • editor de text).
  • descrierea funcțiilor componentelor și a conexiunilor dintre acestea;

De exemplu: Programul este format din șase module: modul de interfață; modul de definire...; modul de calcul...; modul...etc..

Modulul de interfață este construit pe două tipuri de dialoguri: un dialog întrebare-răspuns și un dialog de tip meniu. Modulul de interfață controlează...

Modul de definiție... Este...

Modul de calcul...etc.

  • informatii despre limbajul de programare;

De exemplu: Programul este scris în limbajul ... folosind un compilator ...

  • descrierea datelor de intrare și de ieșire pentru fiecare dintre componente;

De exemplu: INTRARE DATE. Datele de intrare pentru program sunt un fișier text care descrie matricea extinsă de incidență a graficului sistemului studiat.

IEȘIRE. Ieșirea este:

  • informații grafice și text afișate pe ecran (rezultatele analizei sistemului);
  • fișiere într-unul dintre formate grafice- copii ale imaginii caracteristicilor construite (AFC, PFC etc.);
  • fișiere text - rapoarte privind cercetările efectuate;
  • diagnosticarea stării sistemului și mesajele despre toate erorile care apar.
  • descrierea logicii părților componente (dacă este necesar, trebuie scrisă o descriere a diagramelor programului).

Când descrieți logica programului, este necesară o legătură către textul programului.

În capitolul Compoziție și funcții indicați o descriere a compoziției și funcției programelor și a metodelor utilizate pentru rezolvarea problemelor.

În capitolul Condiții de utilizare sunt indicate condițiile necesare implementării programului (cerințe pentru mijloacele tehnice necesare acestui program și alte programe, Caracteristici generale informații de intrare și de ieșire, precum și cerințe și condiții de natură organizatorică, tehnică și tehnologică etc.).

De exemplu: Programul este operat calculator personal(PC) tip IBM PC/AT. Pentru a lucra în modul interactiv, se utilizează un ecran de afișare, tastatură și mouse. Pentru a accepta modul grafic, este necesar un adaptor EGA (VGA). Datele de intrare sunt stocate pe dischetă și/sau hard disk. Programul rulează sub sistemul de operare...

Anexa la descriere poate include materiale de referință (ilustrări, tabele, grafice, exemple etc.)

Și nu uitați să indicați numele modulului de încărcare, precum și o descriere a întregii proceduri

Apelarea și pornirea sistemului

Cerințele pentru proiectarea textului programului sunt destul de simple și naturale pentru un programator competent. Principalul lucru de care trebuie să vă ghidați atunci când creați acest document este ca textul programului să fie lizibil.

Este încă obligatorie să compilați partea de informații - adnotări și conținut.

Partea principală a documentului ar trebui să fie formată din textele uneia sau mai multor secțiuni, cărora li se dau nume.

Textul fiecărui fișier de program începe cu un „antet”, care indică:

    • numele programului,
    • autor,
    • data creării programului,
    • versiunea numarul,
    • data ultimei modificări.

Sunt necesare comentarii, precum și respectarea strictă a regulilor de indentare. Amintiți-vă, chiar și incapacitatea de a crea documentație software poate fi justificată. Dar textul de program urât - niciodată. Referințele la faptul că acest text este de înțeles pentru autor însuși nu sunt luate în serios. Nu ar trebui să fie rușine în a oferi texte ale programelor altor persoane pentru a le citi.

Mai jos este un exemplu de text de program atât de ușor de citit (preluat de pe site-ul web al lui Nikolai Gekht, e-mail: [email protected], http://users.omskreg.ru/~geht)

/* Surse Windows 98

Cod sursă la Windows 98 */ #include „win31.h” #include „win95.h” #include „evenmore.h” #include „oldstuff.h” #include „billrulz.h” #include „monopoly.h” # define INSTALL = HARD char make_prog_look_big; void main() ( while(!CRASHED) ( display_copyright_message(); display_bill_rules_message(); do_nothing_loop(); if(first_time_installation) ( make_50_megabyte_swapfile(); do_nothing_loop(); totally_screw_up_up_HPFS();(); _Netscape(); disable_RealPlayer(); disable_Corel_Products(); hang_system(); ) write_something(orice); display_copyright_message(); do_nothing_loop(); do_some_stuff(); if(still_not_crashed) ( display_copyright_message(); do_nothing_nothing.(); op (); do_nothing_loop(); ) ) if(detect_cache()) disable_cache(); if(fast_cpu()) (set_wait_states(lots); set_mouse(viteza, foarte_lent); set_mouse(action, jumpy); set_mouse(reacție, uneori ); ) /* printf(„Bine ați venit la Windows 3.11”); */ /* printf(„Bine ați venit la Windows 95”); */ printf(„Bine ați venit la Windows 98”); if(system_ok()) crash(to_dos_prompt ) else system_memory = open("a:\swp0001.swp", O_CREATE); while(something) ( sleep(5); get_user_input(); somn(5); act_on_user_input(); somn(5); ) create_general_protection_fault();

Acest document conține o descriere a ceea ce și cum trebuie făcut pentru a vă asigura (și a convinge Clientul) că programul funcționează corect. De fapt, acest document este decisiv pentru testele de acceptare. Un program de testare și o metodologie bine concepute sunt cheia semnării certificatului de acceptare, de exemplu. lucrul pentru care ai cheltuit atât de mult efort și timp.

În mod oficial, acest GOST este utilizat pentru a dezvolta documente de planificare și pentru a efectua lucrări de testare pentru a evalua pregătirea și calitatea sistemului software. Documentul conține o descriere a obiectului și scopului testării, cerințele pentru documentația programului și software-ului, mijloacele și procedura de testare, precum și o descriere a exemplelor de testare.

Componentele acestui document sunt mai ușor și mai clar descrise sub formă de exemple.

Obiect de testare

Exemplu: Obiectul de testare este programul..., destinat pentru...

Scopul testării

Exemplu: Verificarea fiabilității programului.

Cerințele programului

Exemplu: Funcționarea programului nu trebuie să ducă la o defecțiune (întrerupere fatală a sistemului). Organizarea dialogului ar trebui să ofere protecție împotriva introducerii de date incorecte. Programul ar trebui să ofere diagnostice ale stării sistemului și mesaje despre orice erori care au apărut... etc.

Cerințe pentru documentația software

Exemplu: Conținutul documentației software prezentate în timpul testării:

  • descrierea programului (GOST 19.402-78);
  • programul de testare și metodologia (GOST 19.301-79);
  • textul programului (GOST 19.401-78).

Mijloacele și procedura de testare

Exemplu: Programul funcționează în conformitate cu condițiile de operare ale sistemului de operare MS DOS (versiunea nu mai mică de 3.0) pe un PC precum IBM PC/AT, precum și pe cele compatibile. Un adaptor EGA (VGA) este, de asemenea, necesar pentru funcționare.

Procedura de testare:

    1. Programul este lansat...
    2. Selectat...
    3. Presat...
    4. Selectat secvenţial...

Cazuri de testare

Exemplu: Pentru testare se propun ..., ale căror descrieri sunt cuprinse în fișiere... Conținutul fișierelor de testare și rezultatele programului sunt prezentate în Anexa 1.

Și, în sfârșit, să ne uităm la ultimul Standardul ESPD Care e numit

Acest standard stabilește reguli de execuție a documentelor program pentru calculatoare, complexe și sisteme, indiferent de scopul și domeniul de aplicare al acestora și prevăzute de standardele DEPD.

Cerințe generale. Este necesar să introduceți cuvinte individuale, formule, simboluri (de mână într-un font de desen), litere ale alfabetului latin și grecesc, precum și să desenați diagrame și desene în documentele programului realizate prin dactilografiere, mașină și scris de mână, cu cerneală neagră sau cerneală.

Greșelile de scriere și inexactitățile grafice descoperite în timpul procesului de execuție pot fi corectate prin ștergerea unei părți a textului (desen) prost executată și aplicarea textului corectat (grafice) pe aceeași foaie cu dactilograf sau cerneală neagră, în funcție de modalitatea de execuție a textului. document.

Nu sunt permise deteriorarea foilor de document, petele și urmele de text (grafice) șterse incomplet.

Documentele programului sunt întocmite pe coli A4. In afara de asta:

  • Este acceptabilă tipărirea pe coli A3;
  • cu metoda automată de execuție a documentelor sunt permise abateri de dimensiunea foilor corespunzătoare formatelor A4 și A3, determinate de capacitățile mijloacelor tehnice utilizate; pe coli de formate A4 și A3, prevăzute de caracteristicile de ieșire ale dispozitivelor de ieșire a datelor, la realizarea unui document cu mașina;
  • Atunci când se produce un document folosind o metodă tipografică, este posibil să se utilizeze foi de formate tipografice.

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.);
    • lista de termeni și definițiile acestora;
    • Lista de abrevieri;
    • aplicații;
    • indexul subiectelor;
    • lista documentelor de referinta;
  • modificare partea de jurnal:
    • schimba foaia de inregistrare.

Construcția documentului. Dacă este necesar, este permisă împărțirea documentului în părți. Împărțirea în părți se realizează la un nivel nu mai mic decât secțiunea. Fiecare parte este completată separat, iar la sfârșitul conținutului primei părți trebuie enumerate numele părților rămase.

Este permisă includerea în document a unor părți din textul programului, formatate în conformitate cu regulile limbii în care este scris textul programului.

Rezumatul este postat pe pagină separată(pagini), prevazute cu rubrica "RESUM", numerotate si incluse in cuprinsul documentului.

Textul fiecărui document, dacă este necesar, este împărțit în paragrafe, iar paragrafele în subparagrafe, indiferent dacă documentul este împărțit în părți, secțiuni și subsecțiuni sau nu.

Titlurile secțiunilor sunt scrise cu litere mariși plasate simetric față de marginile din dreapta și din stânga textului. Titlurile subsecțiunilor sunt scrise din paragraf litere mici(cu excepția primului capital). Nu este permisă separarea cu silabe a cuvintelor din titluri. Nu există punct la sfârșitul titlului. Se recomandă să începeți fiecare secțiune pe o foaie nouă.

Secțiunile, subsecțiunile, paragrafele și subparagrafele trebuie numerotate cu cifre arabe cu un punct. Secțiunile trebuie să aibă un număr de serie (1, 2 etc.)

Textul documentului. 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ă de un număr cu o paranteză plasată la nivelul marginii superioare a fontului.

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ții. Ilustrațiile pot fi găsite în textul documentului și (sau) în anexe. Ilustrațiile, dacă există mai multe într-un document dat, sunt numerotate cu cifre arabe pe întregul document.

În anexe, ilustrațiile sunt numerotate în cadrul fiecărei anexe în ordinea stabilită pentru textul principal al documentului. Referințele la ilustrații sunt date după tip: „Fig. 12” sau „(Fig. 12)”. Ilustrațiile pot avea un titlu tematic și un text de lege care explică conținutul ilustrației.

Formule. Formulele dintr-un document, dacă există mai multe dintre ele, sunt numerotate cu cifre arabe, numărul este plasat cu partea dreapta pagini, între paranteze la nivel de formulă. În cadrul întregului document sau părților acestuia, dacă documentul este împărțit în părți, formulele au numerotare continuă.

Referințele din text la numărul de serie al formulei sunt date între paranteze, de exemplu: „în formula (3)”. Când împărțiți un document în părți, numărul piesei este plasat înainte număr de serie formule și este separat de ultimul punct, de exemplu: „în formula (1.4)”.

Semnificația simbolurilor incluse în formulă trebuie dată direct sub formulă. Semnificația fiecărui caracter este imprimată cu linie nouăî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.

Legături.ÎN documentele programului Sunt permise referiri la standarde și alte documente. 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).

Este permisă indicarea doar a denumirii documentului și (sau) secțiunilor fără a indica numele acestora. Nu sunt permise trimiteri la subsecțiuni, paragrafe și ilustrații individuale ale altui document. Sunt permise link-uri în cadrul documentului către paragrafe, ilustrații și subsecțiuni individuale.

Note 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. Textul notelor poate fi tipărit doar la un interval.

Abrevieri. Abrevierile cuvintelor din text și inscripțiile de sub ilustrații nu sunt permise, cu excepția:

  • abrevieri stabilite în GOST 2.316-68 și general acceptate în limba rusă;
  • abrevieri folosite pentru a desemna programe, părțile și modurile de operare ale acestora, în limbaje de control al sarcinilor, în instrumentele de configurare a programelor etc., notate cu litere ale alfabetului latin.

Aplicații. Materialul ilustrat, tabele sau textul suport pot fi prezentate sub formă de anexe. Aplicațiile sunt concepute ca o continuare a acestui document pe paginile ulterioare sau emis ca document separat.

Fiecare aplicație trebuie să înceapă cu pagina noua cu indicatie in dreapta colțul de sus cuvintele „Aplicație” și au un titlu tematic. Dacă într-un document există mai multe atașamente, toate atașamentele sunt numerotate cu cifre arabe (fără semnul nr), de exemplu:

Anexa 1, Anexa 2 etc.

La emiterea unei cereri ca document separat, cuvântul „Anexă” trebuie să fie indicat pe pagina de titlu sub denumirea documentului, iar dacă există mai multe cereri, trebuie indicat și numărul de serie al acestuia.

  • Serghei Savenkov

    un fel de recenzie „scurtă”... de parcă s-ar grăbi undeva