Documentația software este un text de referință și informații vizuale care descriu și afișează procesul de dezvoltare, producție, operare și întreținere a produsului software, proprietățile consumatorului și caracteristicile sale tehnice.
Tipuri de documentație pentru software
În conformitate cu această definiție, documentația tehnică pentru software constă în patru tipuri principale:
• Proiect - include o descriere a principalelor prevederi utilizate pentru crearea software-ului și a mediului de lucru.
• Tehnici - algoritmi, cod, interfețe, API.
• Ghidul utilizatorilor pentru utilizatorii programului.
Documentația de proiectare, ca regulă, produsul software descrie în termeni generali. De exemplu, un programator dintr-un proiect poate justifica de ce structurile de date sunt organizate în acest fel (și nu într-un alt mod). De ce acest tip de construcție este proiectat în acest fel sau altul. Modelele sunt evidențiate în proiect. Adesea sunt oferite instrucțiuni despre cum să actualizați programul.
Documentația tehnică (toate pot fi comandate de la TechRightConsult). nu indică doar coduri specifice. De regulă, de asemenea, descrie diferite aspecte ale ceea ce face acest cod. Are o natură tehnică clar exprimată și este folosită în principal pentru a descrie și defini API-uri, algoritmi și structuri de date. Atunci când este compilată, este posibilă utilizarea generatoarelor de documentație (Doxygen, NDoc, javadoc etc.), ceea ce face posibilă menținerea permanentă a acestor documente într-o stare actualizată. În acest din urmă caz, documentația tehnică face parte din codul sursă. Apoi, aceleași instrumente pot fi utilizate atât pentru asamblarea programelor, cât și pentru asamblarea documentației în același timp.
Documentația bună pentru utilizatori constă în:
• un ghid introductiv, care abordează problemele generale de îndeplinire a sarcinilor tipice;
• Tematica, în care fiecare capitol este dedicat explicării unei secțiuni a funcționării programului;
• Un ghid alfabetic, pentru utilizatorii experimentați, care știu bine ce să caute.
Standarde pentru dezvoltarea de software
Baza pentru crearea oricărei documentații pentru produse software este standard.
În astfel de circumstanțe, compania IT decide problema elaborării de documente în diferite moduri. Unii încearcă să copieze și să implementeze standardele occidentale. Alții - folosiți pe piața internă. Încă alții creează propriile lor.
Probleme actuale în elaborarea documentației software
În orice caz, problemele principale în elaborarea documentației tehnice pentru software vor fi următoarele:
• Care este cadrul de reglementare și cum trebuie aplicat acesta?
• Ce fel de documentație este necesară într-un număr imens de documente?
Să ne ocupăm mai degrabă de aceste întrebări.
În prezent se aplică următoarele standarde de documentare:
GOST 19.201 (Sistem unificat de documentare a programului (ETSD);
GOST 34.602 (Complex de standarde pentru sisteme automate (CCAS).
De asemenea, trebuie amintit faptul că, în conformitate cu Legea federală "Cu privire la reglementarea tehnică", standardele naționale au întotdeauna prioritate față de cele internaționale. Adică, este posibil să se utilizeze standarde internaționale numai dacă acestea nu contravin celor naționale! Din fericire, libertatea de acțiune a standardelor interne oferă mult mai multă străinătate. Acestea din urmă sunt revizuite la fiecare 5-7 ani și sunt mai specifice, dar reflectă toată experiența reală pentru perioada specificată. Domestic (fără a avea astfel de specificități dezvoltate) se caracterizează prin dezvoltarea profundă a momentelor conceptuale. Acest lucru vă permite să creați pe baza lor standarde bune în conformitate cu cerințele timpului.
Documentul principal pentru crearea unui produs software este sarcina tehnică, care este folosită pentru a dezvolta (proiecta) programul și a le testa.
Desemnarea produsului software este stabilită în TOR, care este dezvoltat, caracteristicile sale tehnice, calitatea și indicatorii tehnico-economici, precum și instrucțiuni pentru realizarea etapelor de documentare (design, software, tehnologie etc.), compoziția sa și alte cerințe speciale.
Termenii de referință reprezintă un document juridic care, ca anexă, este inclus într-un contract de executare a lucrărilor de proiectare pentru crearea unui program și constituie baza unui astfel de acord.
TK poate fi executat ca proiect de proiect (structura sistemului și funcțiile acestuia sunt descrise fără tehnologiile de implementare a soluției); și sub forma unui proiect tehnic (descrierea detaliată a tehnologiei selectate pentru implementarea proiectului). TK poate fi întocmită și în termeni generali (de exemplu pentru investitori) și cu cele mai detaliate detalii (pentru programatori și în alte cazuri).
Adesea, TK este singurul document care descrie produsul software dezvoltat. În astfel de cazuri, este deosebit de important ca acesta să fie dezvoltat și fabricat de profesioniști.
Articole similare
-
Gosty și standardele industriei pentru dezvoltarea de software - articole - dezvoltare și
-
Software și driver pentru dialogul joystick-urilor gp-a17 series v
Trimiteți-le prietenilor: