Scriitorii tehnici creează diferite tipuri de documentație, de exemplu, manuale de utilizare, documentație API, ghiduri „Cum se face” și așa mai departe. Am scris un articol despre cum să scriu un manual de utilizare, așa că astăzi vă voi vorbi despre crearea unui ghid ‘How to’.
Când primiți sarcina de a crea un ghid, primul pas ar trebui să fie planificarea. Iată ce ar trebui să faceți:
Înțelegeți-vă publicul țintă
Când începeți să scrieți ghidul, ar trebui să înțelegeți clar care este publicul țintă. Care este vârsta lor, care este trecutul lor și așa mai departe. Acest lucru va defini stilul ghidului dumneavoastră „Cum să” la cel mai fundamental nivel – complexitatea limbajului folosit, numărul de termeni și multe alte caracteristici.
Cercetați despre proces
Vă recomand să citiți despre experiența altor persoane în scrierea ghidurilor „Cum să”. Vă va ajuta să vă faceți o imagine clară a muncii viitoare și puteți integra abordările altora în procesul dumneavoastră de lucru. De exemplu, am scris despre procesul de scriere tehnică al lui Amrute Ranade, puteți citi articolul aici: ‘Great Technical Writing Process’. Așadar, puteți folosi și dumneavoastră această metodă pentru a vă ușura scrierea tehnică.
Colectați materiale utile
Înainte de a începe să scrieți, colectați materiale și informații care vă vor ajuta să scrieți un ghid ‘how-to’. Poate fi vorba de informații suplimentare despre un produs, alte ghiduri ‘how-to’ despre produse similare sau altceva.
Scrieți-vă ghidul ‘How-to’
În primul rând, creați un plan – va fi mai ușor să scrieți un ghid dacă îl vizualizați. După toate aceste pregătiri, a sosit momentul să începeți să scrieți. În timp ce creați un ghid, ar trebui să țineți cont de următoarele sfaturi:
- Scrieți în engleză simplă pentru a vorbi aceeași limbă ca și cititorii dvs.
- Limbajul dvs. trebuie să fie întotdeauna concis (de ex, ‘Selectați opțiunea’ în loc de ‘Ar trebui să selectați opțiunea’).
- Creați liste numerotate pentru a structura pașii în cazul în care un utilizator trebuie să îi completeze
- Adaugați conținut vizual, cum ar fi fotografii, capturi de ecran și diagrame.
- Spargeți conținutul în secțiuni cu antet, dar scrieți-le clar
- Dacă doriți să folosiți glume, aveți grijă: este posibil ca oamenii să nu vă înțeleagă
- Adaugați mini-TOC-uri pentru a face subiectele mari mai ușor de citit.
Cel mai esențial sfat este următorul – greșelile de ortografie și gramatică sunt inacceptabile în documentație, așa că verificați-vă temeinic ghidul. Iată o listă cu cele mai bune verificatoare gramaticale gratuite. De asemenea, puteți ruga pe altcineva să corecteze pentru dvs. sau citiți pașii dvs. în sens invers pentru a vă asigura că scrierea dvs. este clară și simplă. Iată alte câteva resurse pentru a scrie o documentație excelentă:
- Grammar Books for Technical Writers
- Style Guides for Technical Writers
Desigur, asta nu este tot ce este de știut despre scrierea ghidurilor „How to”, dar aceste sfaturi sunt cele mai esențiale, după părerea mea. Sper să vă fie de ajutor.
Succes cu ghidurile de scriere!