Cum de a scrie documentație pentru software

O bună documentare de program - indiferent dacă este un document care conține o specificare a cerințelor pentru programatori și testeri, document tehnic pentru utilizatorii interni manual pentru software-ul sau pentru fișierul de ajutor utilizator - ajută la o persoană care lucrează cu software-ul pentru a înțelege caracteristicile și funcțiile sale. Urmați sfaturi - cum să scrie documentația de program atât pentru utilizatorii finali și tehnice.

pași Editare

Metoda 1 de la 2:
Scrierea documentației software pentru utilizatorii tehnici. regulă

Stabiliți ce informații ar trebui să fie menționate. Documente cu privire la cerințele de software sunt un ghid de referință pentru designeri de interfață de utilizator, programatori care scriu cod și testerii, care funcționează de testare, fie că este vorba de software. Informațiile corecte depinde de program, dar pot include următoarele:

• fișiere cheie în aplicație. Acesta poate fi fișiere create de o echipă de dezvoltatori, baze de date, numit în timpul operațiunii de program, și de servicii a unui program terț.
• Funcții și subrutine. Aceasta specifică fiecare funcție și subrutină, inclusiv valorile de intrare și de ieșire.
• variabile și constante de program, și modul în care acestea sunt utilizate în cerere.
• Structura generală a programului. Pentru aplicații bazate pe disc, veți avea nevoie, probabil, o descriere a programului de blocuri individuale și biblioteci, în timp ce ca pentru aplicații web au nevoie de o descriere a paginilor care utilizează fișierele.

Decide cât de mult documentația ar trebui să fie în codul și cât de mult ar trebui să fie separate. Documentația tehnică mai creată în cod, cu atât mai ușor va fi de a actualiza codul, precum și documentația privind diferitele versiuni ale aplicației originale. La o documentație minimă în codul ar trebui să explice funcțiile, rutine, constantele de software și variabile.

• În cazul în care codul este destul de lung, aceasta poate fi făcută într-un fișier de ajutor, pe care le puteți face o căutare de cuvinte cheie sau index. Acesta va fi un mare plus pentru aplicații în care logica programului este împărțit în mai multe pagini și include un număr de fișiere de sprijin, precum și în unele aplicații Web.
• Unele limbaje de programare, cum ar fi Java și NET Framework (Visual Basic.NET, C #), au propriile lor standarde pentru documentarea codului. În astfel de cazuri, urmați liniile directoare standard, - cât de multe documente ar trebui să fie incluse în codul de program.

Metoda 2 din 2:
documentație pentru software de scriere pentru utilizatorii finali Editare

Identificați considerente comerciale pentru înregistrările dumneavoastră. Deși motivele funcționale pentru documentația software - pentru a ajuta utilizatorii să înțeleagă modul de utilizare a aplicației, există alte motive, de exemplu, ajuta la promovarea produselor pe piață, pentru a îmbunătăți imaginea companiei și cel mai important, reduce costurile de suport tehnic. În anumite cazuri, documentația necesară pentru a se conforma anumitor reguli și cerințe legale.

• În niciun caz nu ar trebui să documentația programului nu ar trebui să înlocuiască un design de interfață slabă. În cazul în care ecranul aplicație necesită o mulțime de documente explicative, este mai bine pentru a schimba designul la ceva mai intuitiv.