Documentație Software

documentație pentru software - manuale de utilizare tipărite, interactive (operaționale) documentație și ajutor de text care descrie modul de utilizare a produsului software-ul [1].

Documentul - Element al documentului: informațiile țintă destinate unui anumit public, plasat pe un anumit mediu (de exemplu, în carte, pe disc, carte de referință rapidă) în formatul [1].

Document program - document care conține în funcție de scopul de date necesare pentru proiectarea, fabricarea, operarea, programe de întreținere sau de instrumente software [2].

Există patru tipuri de bază de documentație pentru software-ul:

• Arhitectura / Design - prezentare generală a software-ului, inclusiv mediul de operare, precum și o descriere a principiilor care ar trebui să fie utilizate la crearea unui software
• tehnică - documentația privind codul. algoritmi. interfețe, API
• de utilizare - ghid pentru utilizatorii finali, administratorii de sistem și de alți membri ai personalului
• marketing

Arhitectura documentare / proiectare

Documentația de proiect descrie, de obicei, produsul în general. Fără a descrie modul în care este folosit ceva, probabil răspunde la întrebarea „de ce acest lucru.“ De exemplu, în documentul de proiect programator poate descrie rațiunea de ce aceste structuri sunt organizate în acest mod. Descrie motivele pentru care orice clasă este proiectat într-un anumit fel, modelele ies în evidență. în unele cazuri, chiar și având în vedere ideea de modul în care va fi posibil să se realizeze îmbunătățiri în viitor. Nimic din toate acestea sunt incluse în documentația tehnică sau de utilizator, dar este foarte important pentru proiect.

La crearea unui program, doar un singur cod. de obicei, nu este suficient. Ar trebui să se acorde un text care descrie diferitele aspecte ale ceea ce face codul. Această documentație este adesea inclusă direct în codul sursă sau furnizat împreună cu acesta.

Această documentație se exprimă cu tărie natură tehnică și este utilizat în principal pentru a detecta și de a descrie API. structuri de date și algoritmi.

documentație pentru utilizator

Spre deosebire de documentația tehnică, axat pe codul și modul în care funcționează, doar documentația pentru utilizator descrie modul de utilizare a programului.

În cazul în care produsul este o bibliotecă de software. documentație de utilizator și documentația pentru codul sunt foarte aproape, aproape echivalent. Dar, în general, nu este.

De obicei, documentația de utilizare este un ghid al utilizatorului. care descrie fiecare funcție a programului, precum și măsuri pe care le puteți urma pentru a utiliza această funcție. documentație de utilizare bună merge un pas mai departe și oferă instrucțiuni despre ce să facă în caz de probleme. Este important ca documentația să nu inducă în eroare și a fost relevantă. Managementul ar trebui să aibă o structură clară; foarte util în cazul în care există un indice de subiect transversal. coerență logică și simplitatea sunt de asemenea importante.

Există trei abordări privind organizarea documentației de utilizator. Ghidul pentru începători (Eng. Tutorial), cel mai util pentru utilizatori noi, se urmărește în mod constant pentru o serie de măsuri care sunt utilizate pentru a îndeplini orice sarcini tipice. Abordarea tematică, în care fiecare capitol al manualului este dedicat un subiect special, mai potrivite pentru îmbunătățirea utilizatorului. În acest din urmă, a treia abordare, echipa sau sarcina sunt organizate în directorul alfabetic - de multe ori bine acceptate de către utilizatorii avansați care sunt familiarizați cu ceea ce caută. Reclamațiile utilizatorilor sunt, de obicei legate de faptul că documentația acoperă doar una dintre aceste abordări, și este, prin urmare, foarte potrivit pentru doar o singură clasă de utilizatori.

În multe cazuri, dezvoltatorii de software limitată set de documentație de utilizare este built-in numai sistemul de ajutor (ing. Ajutor online), care conține informații de referință cu privire la comenzile sau elementele de meniu. Lucrările la formarea noilor utilizatori și susținerea îmbunătățirii utilizatorul este transmis editorilor privați, oferind adesea asistență semnificativă pentru dezvoltatori.

documentație de marketing

• ascuți interes în produsul de către potențialii utilizatori
• i informeze despre ceea ce face ca produsul, astfel încât să se potrivească cu așteptările lor ceea ce primesc
• pentru a explica poziția produsului în raport cu soluțiile concurente

Unul bune practici de marketing - care furnizează un slogan - o expresie ușor de reținut simplu, ilustrând faptul că dorim să transmitem către utilizator, precum și caracterizează sentimentul. care creează un produs.

Se întâmplă adesea ca cutia produsului și alte materiale de marketing dau o imagine mai clară a posibilităților și modalitățile de utilizare a programului decât orice altceva.