Documentație software - manuale de utilizare tipărite, documentație on-line (online) și text de ajutor care descrie modul de utilizare a produsului software [1] .
Document - un element de documentare: informație țintită destinată unui anumit public, plasată pe un anumit suport (de exemplu, într-o carte, pe un disc, într-un card de referință rapidă) într-un format dat [1] .
Documentatie program - documente care contin, in functie de scop, datele necesare dezvoltarii, producerii, functionarii, intretinerii unui program sau instrument software [2] .
Există patru tipuri principale de documentație software:
Documentația de proiectare descrie de obicei produsul în termeni generali. Fără a descrie cum va fi folosit ceva, mai degrabă răspunde la întrebarea „de ce este așa”. De exemplu, într-un document de proiectare, un programator ar putea descrie rațiunea pentru care structurile de date sunt organizate așa cum sunt. Sunt descrise motivele pentru care o clasă este proiectată într-un anumit mod, sunt evidențiate modele și, în unele cazuri, chiar sunt oferite idei despre cum pot fi aduse îmbunătățiri în viitor. Nimic din toate acestea nu este în documentația tehnică sau a utilizatorului, dar totul este cu adevărat important pentru proiect.
Când creați un program, codul singur nu este de obicei suficient. Ar trebui furnizat un text care să descrie diferite aspecte ale exact ceea ce face codul. O astfel de documentație este adesea inclusă direct în codul sursă sau furnizată împreună cu acesta.
O astfel de documentație este de natură foarte tehnică și este utilizată în principal pentru a defini și descrie API-uri , structuri de date și algoritmi .
Adesea, la compilarea documentației tehnice, se folosesc instrumente automate - generatoare de documentație , cum ar fi Doxygen , javadoc , NDoc și altele. Ei își iau informațiile din comentarii formatate special din codul sursă și creează manuale de ajutor într-un anumit format, cum ar fi text sau HTML .
Utilizarea generatoarelor de documentație și a comentariilor de documentație s-a dovedit a fi un instrument convenabil de mulți programatori, din diverse motive. În special, cu această abordare, documentația face parte din codul sursă, iar aceleași instrumente pot fi folosite pentru a construi programul și a construi documentația pentru acesta în același timp. De asemenea, este mai ușor să păstrați documentația la zi.
Spre deosebire de documentația tehnică, care se concentrează pe cod și modul în care acesta funcționează, documentația pentru utilizator descrie doar modul de utilizare a programului.
Dacă produsul este o bibliotecă de software , documentația utilizatorului și documentația codului devin concepte foarte apropiate, aproape echivalente. Dar, în general, acesta nu este cazul.
De obicei, documentația utilizatorului este un manual de utilizare care descrie fiecare caracteristică a programului, precum și pașii de urmat pentru a utiliza acea caracteristică. O documentație bună pentru utilizator merge și mai departe și oferă instrucțiuni despre ce trebuie făcut dacă apar probleme. Este foarte important ca documentația să nu inducă în eroare și să fie actualizată. Conducerea ar trebui să aibă o structură clară; foarte util dacă există un indice transversal . Coerența logică și simplitatea sunt, de asemenea, de mare importanță.
Există trei abordări pentru organizarea documentației utilizatorului. Ghidul introductiv , cel mai util pentru utilizatorii noi, vă ghidează printr-o serie de pași pentru a finaliza unele sarcini comune. O abordare tematică, în care fiecare capitol al manualului se concentrează pe un anumit subiect, este mai potrivită pentru utilizatorii avansați. În ultima, a treia abordare, comenzile sau sarcinile sunt organizate ca referință alfabetică - adesea bine primite de utilizatorii avansați care știu bine ce caută. Plângerile utilizatorilor se referă de obicei la faptul că documentația acoperă doar una dintre aceste abordări și, prin urmare, este potrivită pentru o singură clasă de utilizatori.
În multe cazuri, dezvoltatorii de produse software limitează setul de documentație pentru utilizator doar la sistemul de ajutor încorporat ( ajutor online în engleză ), care conține informații de ajutor despre comenzi sau elemente de meniu. Sarcina de a educa noi utilizatori și de a sprijini utilizatorii în evoluție este lăsată în seama editorilor privați, care oferă adesea asistență semnificativă dezvoltatorilor.
Pentru multe aplicatii este necesar sa ai langa ele materiale promotionale pentru a interesa oamenii atragandu-le atentia asupra produsului. Această formă de documentare este destinată:
Una dintre bunele practici de marketing este de a oferi un slogan - o frază simplă captivantă care ilustrează ceea ce dorim să transmitem utilizatorului, precum și să descrie sentimentul pe care îl creează produsul.
Se întâmplă adesea ca cutia produsului și alte materiale de marketing să ofere o imagine mai clară a posibilităților și modalităților de utilizare a programului decât orice altceva.
| Dezvoltare de software | |
|---|---|
| Proces |
|
Concepte de nivel înalt | |
| Directii |
|
| Metodologii de dezvoltare | |
| Modele |
|
Cifre notabile |
|