Documentație tehnică Mai mult decât un manual ›Revista Webwriting - de la publicare
Există mulți pași implicați în introducerea unui nou produs. Produsul trebuie planificat cu atenție și fiecare pas de dezvoltare este examinat cu atenție. Când produsul este finalizat și gata pentru lansarea pe piață, dezvoltatorul ar trebui să se asigure că completează cu atenție documentația tehnică a produsului. Legiuitorii necesită documentație tehnică detaliată pentru a asigura siguranța și funcționarea profesională a produsului. Cu documentația tehnică, nu numai că ajutați utilizatorul produsului, ci și vă protejați compania de eventuale atacuri legale. Acest lucru reduce riscul de răspundere și evită clienții supărați, cărora în zilele noastre le place, de asemenea, să-și dezvolte furia pe social media.
Documentație tehnică internă și externă
Documentația tehnică externă este destinată clientului sau utilizatorului produsului. Aceasta este pentru a se asigura că utilizatorul pornește produsul în mod corespunzător și că poate citi mai întâi documentația în caz de probleme. De regulă, documentația tehnică pentru client este scrisă de editori speciali. Dacă produsul este vândut pe piețele internaționale, textele trebuie traduse profesional în limbile respective ale fiecărei țări. De exemplu, în Europa acestea sunt engleză, spaniolă, poloneză și suedeză. Documentația tehnică externă este mai bine cunoscută sub numele de instrucțiuni de utilizare, instrucțiuni de utilizare sau manual de utilizare, în funcție de produs și grupul țintă.
Munca profesională implicată în crearea documentației este deosebit de importantă. În ciuda limbajului tehnic utilizat, utilizatorul ar trebui să aibă puține probleme în înțelegerea instrucțiunilor de utilizare. În plus față de inteligibilitatea textelor, regulile stilului și gramaticale trebuie, desigur, respectate. În plus față de documentația standard pe hârtie care este inclusă în fiecare produs, este logic să furnizați versiuni online pentru client. Acest lucru economisește utilizatorului o căutare lungă dacă instrucțiunile originale au fost pierdute. Lucrul cu un sistem profesional de gestionare a conținutului pentru a crea documentația are multe avantaje. Editorii sunt pregătiți perfect în scrierea unor astfel de texte și sunt încrezători în stilul lor de scriere. Recunoașteți informații importante și le puteți rezuma eficient ca document. Folosirea scriberilor externi economisește timp și bani. În plus, puteți fi sigur că documentația este implementată în conformitate cu toate liniile directoare și specificațiile comune.
discuţie
Abonați-vă la comentarii (RSS)
2 comentarii despre „Documentația tehnică: mai mult decât un manual de instrucțiuni”.
Pentru mine, ca dezvoltator unic (software), crearea enervantă a documentației este, de asemenea, o oportunitate de a privi programul meu (încă o dată) din perspectiva viitorului utilizator.
Pe cât posibil, cunoștințele din faza de creare a documentației ar trebui să poată curge în produs; pentru că de multe ori recunoașteți doar atunci când doriți sau trebuie să explicați produsul unui profan unde se află problema și ce s-ar fi putut rezolva într-un mod mult prea complicat.
Prin urmare, companiile mai mari au nevoie de o opțiune de feedback de la scriitorul de instrucțiuni către dezvoltatori.
Sau, ar trebui să includeți punctul de vedere al autorului cât mai devreme posibil în procesul de dezvoltare.
Recent am experimentat un adevărat mega-flop cu documentație insuficientă: am cumpărat un vaporizator/rezervor grozav pentru vaporii mei electronici, dar nu a fost descris modul în care sunt reglementate debitul și debitul de lichid. Am trimis piesa înapoi pentru că am găsit-o „blocată” în partea de sus - deși ar trebui să fie un Topfiller! Apoi am recuperat partea și iată: acolo unde totul era închis, am văzut brusc găuri ... totul este ok?
În niciun caz! Găurile de umplere au dispărut din nou data viitoare când am încercat ... Pe scurt: mi-a luat mult timp să intru pe pistă. Piesa avea mecanici cu adevărat ingenioase pentru a deschide și închide acele găuri de intrare. Din păcate, deloc explicativ și NEDOCUMENTAT!
Rezultat: produsul este în prezent vândut . sigur, nimeni nu poate face față fără probleme ...