cum se scrie un Manual de Utilizare

un manual de utilizare sau un ghid de utilizare este un document de comunicare tehnică conceput pentru a educa utilizatorii cu privire la un anumit produs. Produse în format tipărit sau digital, ele pot fi scrise despre aproape orice produs, dar sunt cele mai frecvente cu software-ul și hardware-ul computerului, dispozitivele electronice și jocurile video.

de obicei scris de scriitori tehnice sau designeri de produs, scopul său este de a informa utilizatorii și a le ajuta să rezolve orice probleme legate de produs. Ca o componentă vitală a distribuției produselor, calitatea manualului dvs. poate avea un impact puternic asupra experienței generale a clienților, motiv pentru care doriți să o faceți corect!

în acest articol, vă voi împărtăși sfaturi despre cum să scrieți un manual de utilizare care transmite clar informații clienților dvs. și vă voi arăta cum îl puteți organiza procesul de scriere în Zenkit.

Sfaturi pentru scrierea unui manual de utilizare

există multe lucruri care intră în scrierea unui manual de utilizare. De la descrieri de caracteristici, la instrucțiuni de reparații, la toate detaliile legale și avertismente de siguranță. Iată câteva sfaturi de care trebuie să țineți cont atunci când vine vorba de scrierea acestuia:

  1. cunoaște-ți obiectivul

fiecare manual de utilizare ar trebui să aibă un scop. În mod obișnuit, este pentru a ajuta utilizatorii să rezolve problemele legate de produsul dvs., dar cu aceasta ar trebui să decideți și cum doriți să îi ajutați. După ce ați decis unghiul pe care doriți să îl luați, împărțiți informațiile în secțiuni și instrucțiuni pas cu pas care sunt suficient de simple pentru a le urma.

  1. determinați utilizatorul

este imperativ să cunoașteți tipul de public care vă va citi manualul de utilizare, deoarece va influența modul în care îl scrieți. Cunoașterea utilizatorului mediu vă poate oferi o idee despre limba pe care ar trebui să o utilizați atunci când scrieți manualul de utilizare, formatul și stilul general. De exemplu, scrierea pentru specialiștii IT pricepuți în tehnologie va fi foarte diferită de scrierea pentru părinții cu familii tinere.

  1. utilizați un limbaj accesibil

indiferent de publicul dvs., limba textului manualului de utilizare ar trebui să fie accesibilă chiar și celor mai non-tehnice persoane. Trebuie să presupunem că cititorul are cunoștințe zero despre produsul dvs., deci ar trebui să fie inteligibil, clar și concis. Ar trebui să se adreseze cititorului și utilizarea jargonului ar trebui să fie limitată.

  1. faceți-l vizual

se știe că oamenii procesează date vizuale de 60.000 de ori mai rapid decât textul, motiv pentru care doriți ca manualul dvs. de Utilizare să includă imagini. Manualele de utilizare includ aproape întotdeauna imagini relevante cu textul. Unele produse chiar împărtășesc imagini de captură de ecran cu instrucțiuni pas cu pas sau sunt doar imagini pur (manualele IKEA sunt celebre fără text). Imaginile pot ajuta cu adevărat să transmită mesajul pe care doriți să îl comunicați cititorului.

  1. spori findability

recunoaște, nimeni nu va citi întregul manual de utilizare, astfel încât pentru cititorii pentru a găsi valoare în ea, trebuie să-l facă suficient de simplu pentru ca oamenii să degresat prin și pentru a găsi ceea ce caută. Dați-i un format curat, având un aspect consistent de la o pagină la alta și asigurați-vă că există mult spațiu între bucăți de text. Utilizați cuvinte cheie familiare legate de produs și asigurați-vă că fontul este simplu și lizibil.

cum să vă planificați manualul de utilizare

Zenkit este un instrument excelent pentru planificarea unui manual de utilizare. Instrumentul de management de proiect este dotat cu caracteristici care vă permit să colecteze date și apoi structura pentru a crea un flux de lucru optimizat. Iată pașii pentru organizarea procesului de scriere a Manualului de utilizare.

Pasul 1:

Înscrieți-vă pentru un cont Zenkit gratuit și conectați-vă.

Pasul 2:

după ce v-ați personalizat profilul, faceți clic pe „Colecție nouă”, dați colecției un nume și apăsați enter sau „creați”. Veți fi direcționat către vizualizarea Kanban implicită.

puteți oferi colecției dvs. un mic personaj personalizând o pictogramă pentru aceasta. Pentru a face acest lucru, faceți clic pe titlul colecției, selecție „personalizare” și alegeți culorile și sigla pictogramei dorite.

sunt personal un fan al utilizării unei plăci Kanban pentru a cartografia vizual un plan de proiect. Sistemul de planificare vizuală este excelent pentru identificarea blocajelor și a problemelor care pot apărea în timpul procesului de planificare. De asemenea, vă poate oferi o imagine de ansamblu clară a modului în care proiectul dvs. progresează.

vizualizarea Kanban vă prezintă trei coloane implicite etichetate ca „To-Do, In Progress, and Done”. Puteți redenumi coloanele făcând clic pe unul dintre numele etichetelor și accesând secțiunea nume din caseta de meniu care apare. Pentru a adăuga mai multe etape la fluxul de lucru, tot ce trebuie să faceți este să faceți clic pe „+ Adăugați etapă”, să dați coloanei o etichetă și fie să faceți clic pe „Creați”, fie să apăsați enter.

desigur, puteți selecta cât mai multe etape, după cum doriți pentru fluxul de lucru și etichetați-le orice credeți de cuviință. Etapele pe care le-am urmat sunt următoarele:

  • Info & resurse
  • Feedback & instrucțiuni
  • secțiuni
  • schițe

Pasul 3:

odată ce structura fluxului de lucru a fost determinată, puteți începe să adăugați alte elemente ca elemente sub fiecare coloană.

după cum am menționat la începutul acestui articol, un proiect precum scrierea unui manual de utilizare implică o mulțime de conținut; conținut care trebuie împărțit în diferite capitole și secțiuni și secțiuni de secțiuni.

Subitemele Zenkit sunt caracteristica perfectă pentru descompunerea sarcinilor mai mari în cele mai mici. Unul dintre cele 12 câmpuri personalizate ale instrumentului nostru de management de proiect, acesta prezintă toate articolele dvs. într-un mod structurat, astfel încât să puteți lucra cu o cronologie gestionabilă.

puteți descompune în continuare elementele deja defalcate în sub-sub-elemente!

pentru a adăuga un subitem la unul dintre elementele dvs., trebuie doar să faceți clic pe element pentru a-l deschide. Apoi faceți clic pe semnul ” + „care se află deasupra secțiunii de comentarii, apoi selectați”câmp personalizat”. În secțiunea” Tip”, derulați în jos și selectați câmpul” subitems”. Nu uitați să dați câmpului un nume!

Pasul 4:

pentru a adăuga o structură suplimentară la fluxul de lucru, puteți utiliza vizualizarea ierarhiei Zenkit. Pentru a activa această vizualizare în colecția dvs., faceți clic pe „Kanban” (sau numele vizualizării în care vă aflați) pe care o veți găsi în colțul din dreapta sus și selectați „Vizualizare nouă”. Ar trebui să apară o extensie de meniu și să selectați pur și simplu „ierarhie”.

Pasul 5:

când utilizați prima vedere ierarhie, veți găsi că elementele sunt neconectate. Le puteți conecta prin glisarea și fixarea fiecărui element pe panoul ierarhiei principale. Dacă trageți un element părinte, veți găsi că subitemele vor veni împreună cu acesta.

ierarhia alocată unui element depinde de locul în care îl plasați. De exemplu, elementele trase în partea de sus vor avea o ierarhie de nivel unu, iar elementele care sunt trase sub altul se vor transforma într-un subitem al acelui element.

vizualizarea ierarhie vă arată fiecare element pe care l-ați adăugat la ierarhia elementelor utilizând indentări pentru a indica când un element devine subitem. Puteți obține o imagine de ansamblu a sarcinilor de top numai sau a vedea totul în proiectul dvs. dintr-o dată prin prăbușirea sau deschiderea elementelor.

planificarea altor tipuri de documente și materiale text

la fel ca planificarea unui manual de utilizare, Zenkit poate fi folosit pentru a planifica alte documente sau materiale text grele. Vizualizarea ierarhiei și caracteristica subitemului sunt perfecte pentru planificarea oricărui proiect care necesită organizarea unei cantități mari de conținut care trebuie împărțit în diferite secțiuni, cum ar fi un roman sau o teză de colegiu.

plan de scriere a romanului

scrierea unui roman poate dura ani de zile pentru a fi finalizat, motiv pentru care este o idee bună să ai undeva unde să notezi totul. Folosind un șablon similar cu ghidul manualului de utilizare, vă puteți structura romanul capitol cu capitol și puteți urmări toate detaliile personajului, complotului și temei într-o singură platformă.

planul tezei/disertației

de la idei de subiect la cercetare până la colectarea datelor, scrierea unei teze sau disertații necesită multă planificare. Folosind Zenkit pentru a gestiona totul, vă poate ajuta să vă faceți teza la timp și să vă asigurați că nu veți trece cu vederea ceva important!

Faceți clic aici pentru a utiliza șablonul nostru de planificare a tezei/disertației.

un manual de utilizare excelent comunică informații în mod clar cititorului, astfel încât acesta să poată depăși orice probleme care pot apărea cu produsul. Folosind Zenkit pentru a planifica procesul de scriere, și profitând de vedere ierarhie și caracteristica subitem, vă poate ajuta să producă un manual de utilizare de calitate, care poate oferi clienților cea mai bună experiență posibilă.

care a fost ultimul manual de utilizare pe care l-ați considerat util?

noroc,

Dinnie și echipa Zenkit

a fost util acest articol? Vă rugăm să-l votezi!

Lasă un răspuns

Adresa ta de email nu va fi publicată.