Documentatie site

[moldo]

[Ctek]

La ce gen de documentatie te referi ?

Documentatie pentru Programatori ?
Documentatie pentru utilizatori ?
Documentatie pentru Administrare ??

[moldo]

la toate

[Ctek]

Pai e cam complicat.

Pentru codul sursa trebuie in timp ce scrii codul sa iti adaugi notitele si pe baza lor poti crea o documentatie, poti folosi phpdocumentor daca nu ma insel in privinta numelui.

Documentatia cu privire la utilizator e complicata pentru ca trebuie sa te pui in perspectiva userului si sa scrii de la cap la coada tot algoritmul de lucru.
Cu click acolo pentru acea optiune, cu explicatii de ce trebuie completat un camp si cu ce etc etc.

Documentatia de administrare este pentru Userii mai avansati si acolo poti intra in mai multe detalii cu privire la mecanismele aplicatiei si ce conditii trebuie indeplinite pentru a functiona. ce masina e necesara, ce modificari se aduc mediului de operare etc etc ...

Modele nu prea cred ca o sa gasesti pentru ca sunt diferite.

Dar in principiu fiecare documentatie trebuie sa aiba

1 Ce descrie acel document
2 Pentru ce este facuta
3 Pentru cine este facuta
4 Ce nivel
5 Revizia (daca este cazul)
6 Documentatia in sine
7 Referinte, studii de caz exemple


Cred ca ti-ai facut o idee

PS: Daca nu documentezi din timpul crearii e cam greu pe urma...

[moldo]

la codul sursa sa pun numai ce e mai important si sa explic ce face sau cum?

[rudisoft]

Pentru codul sursa iti recomand cu caldura phpdoc.org. Citeste cu atentie documentatia de acolo si o sa te miri si tu de ce reuseti sa faci
Dar, dupa cum a spusi Ctek, daca nu ai facut de la inceput asa, o sa fie mai anevoios...

[Amenthes]