testarea de documentare

Documentația - este o altă componentă a produsului software de orice organizație care se respectă dedicat dezvoltării de software. Dar nu toate organizațiile au plătit o cantitate suficientă de timp în picioare documentația de dezvoltare ... De foarte multe ori nu suntem mulțumiți de a face cu produse software inteligente și element de documente rebarbativ, confuz și neajutorat dedesubt.

Să încercăm să pună laolaltă criteriile de testare, care formează chintesența documentației de înaltă calitate. Cred că ar fi corect dacă am pus acest lucru toate regulile clare, gramatica, deoarece nu este un succes ascuns de presă.

• caracterul complet și veridicitatea. Orice documentație descrie cu precizie funcționalitatea care este prezent în cerere. Și această descriere ar trebui să acopere absolut toate funcționalitățile, nu doar cel mai important.

• Navigație. Și nu doar de navigare și navigare ușoară. Utilizatorul nu ar trebui să aibă nici o problemă găsirea informațiilor necesare pentru el. Toți copacii de fișiere, marcajele și așa mai departe ar trebui să fie într-un loc vizibil, de îndată ce utilizatorul deschide documentul. Indexul alfabetic, căutarea - trebuie să existe ceva care va ajuta să găsească o soluție sau o descriere a problemei.

• Din punct de mai sus, implică documentație structurată. Toate documentele trebuie să fie în ordine, pe secțiunile. Textul ar trebui să fie, de asemenea, o structură clară - să fie capabil în orice moment să-și amintească unde a fost de ședere sau să înțeleagă ce paragraful conține exact informațiile de care avem nevoie.

• Termenii și semnificația lor. Toate documentele pot utiliza o serie de termeni, acronime și abrevieri. Fiecare dintre aceste entități trebuie să aibă sens și interpretarea lor.

• Disponibilitatea utilizatorului. Documentația trebuie să fie cât mai clar pentru orice public-țintă.

• Dacă documentația este creată pentru utilizatorii străini - este necesară atragerea specialiștilor din sectorul lingvistic. până la difuzoare.

Există mai multe cerințe pentru documentația de pregătire și testare. Astăzi am discutat despre poziția de bază. Dar regula principală, care ne va ajuta - este abilitatea de a te pune în locul utilizatorului, care este într-o anumită situație problematică.