Un document tehnic consistent este unul care insuflă încredere și încredere utilizatorilor finali. Totul începe cu un șablon. Nu contează dacă creați o carte, un fișier de ajutor sau un site web. Un șablon este obligatoriu.
Odată ce ați creat șablonul și sub control, trebuie să urmați un ghid de stil pentru a crea un document bine rotunjit și consecvent.
Iată câteva indicații utile:
Începeți toate listele ordonate (numerotate) și neordonate cu un verb de acțiune. „Introduceți parola” este mai bun decât „Sistemul vă va cere să introduceți parola. Vă rugăm să faceți acest lucru”.
Multe acțiuni ale utilizatorului din documentația software se adresează unui utilizator care face clic pe un buton pentru a afișa un anumit ecran. Urmați același model folosind același tip de propoziție compusă pentru a descrie cele două acțiuni legate.
De exemplu: „Faceți clic pe butonul Următorul pentru a afișa ecranul de configurare”.
Puteți utiliza același model primul-acest-urmat-de-acel și într-un context hardware:
Un altul: „Măsurați tensiunea înainte de a conecta firele pentru a asigura siguranță”.
Decideți dacă doriți să utilizați „check-box” sau „check-box” și rămâneți cu ea. Nu comutați înainte și înapoi între cele două utilizări.
Același lucru este valabil și cu „caseta derulantă” și „caseta derulantă” sau „lista derulantă”.
Legendele tabelelor preced de obicei tabelele, în timp ce legendele figurilor urmează figurilor. Asigurați-vă că sunteți în concordanță cu modul în care utilizați titlurile tabelelor și legendele figurilor.
Nu există drepturi sau greșeli stilistice și absolute în această afacere și nu există „prea multă” consistență atunci când vine vorba de scrierea tehnică. Ceea ce este mai important este să luați un set de decizii de stil și format și să rămâneți cu el.