Ghid documentatie proiect software studenti

Un proiect software include pe langa aplicatia propriu-zisa si o documentatie

aferenta. Aceasta documentatie trebuie sa include atat informatii despre
functionalitatea aplicatiei si detaliile de implementare. De mentionat ca doar
codul sursa, chiar daca este comentat, nu este suficient pentru a fi o buna sursa
primara de informatie si drept urmare intocmirea documentatiei nu trebuie
tratata superficial. In ceea ce priveste disciplina de studiu, continutul si calitatea
documentatiei vor avea o pondere importanta in stabilirea notei finale.

In principal, documentatia proiectului software ar trebui sa include

urmatoarele sectiuni si continut aferent fiecareia dintre acestea.

1. Pagina de titlu

Aceasta pagina va include:

-denumirea disciplinei
-numele studentului/studentilor
-numele proiectului
-data trimiterii
-numele destinatarului

2. Rezumat
Descrierea in rezumat a lucrarii/proiectului (nu a problematicii in
general)

3. Scopul/utilitatea proiectului
Enuntarea scopului proiectului adica la ce foloseste. Utilitati de genul
distrarea utilizatorului sunt oarecum puerile si nepotrivite statutului de
student. Si nici formulari de genul am ales acest proiect pentru a invata
sa programez in Java

4. Grupul tinta
Mentionarea grupului/categoriei de utilizatori pentru care aplicatia poate
fi utila adica cui foloseste. Vor fi incluse categoria de varsta, categoria de
studii si categoria profesionala, precum si eventule motivatii.

5. Introducere
Definirea in rezumat a problemei folosind eventual referinte, in cazul in
care problema are si o componenta teoretica. In plus o prezentare tot in
rezumat a catorva aplicatii recente care rezolva aceiasi problema sau
similare. Si aici cu referintele corespunzatoare
6. Functionalitatea
Descrierea functionalitatii aplicatiei. Se va folosi si o diagrama UML
pentru descriere functionalitate. Se poate realiza cu Paint sau orice alt
free-software (https://www.smartdraw.com/uml-diagram/uml-diagram-
software.htm)
Ceva simplu dar clar, precum in exemplele de mai jos:

Sau
 sau

Detalii tehnice de implementare/codare nu sunt necesare. Exista o

sectiune dedicata pentru asta.

7. Interfata Utilizator
Aceasta sectiune trebuie sa explice cum interactioneaza utilizatorii cu
aplicatia software. Toate aspectele, incepand cu momentul in care aplicatia
este lansata in executie si pana la incheierea sesiunii de lucru. O diagrama
functionala privind interfata utilizator se impune a fi folosita. Exemple:
8. Rularea/executia aplicatiei

In aceasta sectiune va fi explicat in detaliu modul de executie al programului

din punct de vedere al utilizatorului. Nu vor fi incluse descrierile
algoritmilor, structurilor de date, modul de implementare! Vor fi precizate
datele de intrare cerute de program utilizatorului, iesirile programului,
funtionalitatea programului, sistemul de meniuri precum si alte componente
ale programului. Aceasta sectiune ar trebui sa arate precum manualul
utilizatorului. Este indicat a fi incluse aici screen outputs.

9. Input si Output
In aceasta sectiune este descris formatul intrarilor si iesirilor programului,
inclusiv cele preluate sau transmise in fisiere. Cateva exemple sunt indicat4.

10. Structura aplicatiei/programului

Aceasta sectiune reprezinta manualul tehnic. O descriere generala a
programului se impune.
Fiecare parte a programului (subprograme, module, clase) trebuie explicate
cu suficiente detalii astfel incat un cititor cu expertiza in domeniu sa
inteleaga totul. Structurile de date si algoritmii trebuie de asemenea explicate
clar si complet.

11.Exemple
Daca intelegerea programului este facilitata de exemple, acestea trebuies
furnizate cititorului. Exemplele trebuie de asa natura alese incat sa acopere
diferite comportari ale programului in cazul datelor de intrare diferite.

12. Imbunatatiri si extensii

Vor fi prezentate suscint imbunatirile necesar a fi aduse in viitor si eventual
extensii viitoare ale programului.

13.Concluzii

14. Referinte
Toate aplicatiile, definitiile, relatiile matematice, figurile referite in acest
document care nu apartin autorului vor fi precizate in aceasta sectiune.

15. Anexe
Codurile sursa trebuie incluse in anexe.