Cum să scrieți o bază de cunoștințe tehnice pentru site-ul dvs., să dezvoltați documentația tehnică

Care este baza de cunoștințe tehnice și de ce aveți nevoie de ea?

Baza de cunoștințe este o modalitate de gestionare a informațiilor tehnice, astfel încât acestea să poată fi menționate și distribuite. Baza de cunoștințe tehnice conține, de obicei, informații privind modul de utilizare a capabilităților sau proceselor, răspunsuri la întrebările tehnice și ajută la rezolvarea problemelor.

Dacă în afacerea dumneavoastră există o aplicație, un program sau un site are funcționalitate unică, apoi câteva instrucțiuni tehnice bune va face mai ușor să le folosească, ar fi util pentru o varietate de motive:

  • Acesta oferă un depozit de informații privind problemele, problemele și soluțiile. Aceasta înseamnă că atunci când problema este rezolvată, soluția va fi înregistrată, ceea ce va economisi timp în viitor.
  • Oportunitățile și problemele tehnice sunt explicate în termeni de amatori - reprezentând astfel un punct de pornire convenabil de la care puteți începe atât angajații, cât și clienții.
  • Îi ajută pe clienți să rezolve problemele și să găsească răspunsuri la solicitări fără a trebui să contacteze asistența tehnică.
  • De asemenea, vă poate ajuta personalul de asistență să răspundă la întrebări mai rapid, dacă clienții îl contactează încă.

Următoarele paragrafe sunt dedicate modului în care trebuie să vă structurați baza de cunoștințe și cum să descrieți detaliile tehnice, cu exemple practice de succes din experiență.

Cum să vă structurați baza de cunoștințe tehnice

Baza ta de cunoștințe va fi mai puțin eficace în cazul în care oamenii nu pot găsi ceea ce caută, de aceea este foarte important modul în care structura conținutul.

Alegeți un aspect ușor de perceput, care permite oamenilor să obțină informațiile pe care le caută cât mai repede posibil. Împărțiți conținutul în secțiuni și oferiți o metodă de căutare evidentă.

Exemplu: baza de cunoștințe Groove are un marcaj transparent și o casetă de căutare bine definită, care ajută utilizatorii să găsească exact ceea ce au nevoie.

Cum să scrieți o bază de cunoștințe tehnice pentru site-ul dvs., să dezvoltați documentația tehnică

Titlurile bine formate ajută oamenii să găsească, să lege și să distribuie articole din baza dvs. de cunoștințe. Utilizați întotdeauna o limbă directă și simplă și încercați să includeți cuvinte cheie pe care utilizatorii pot căuta. Aplicați o abordare individuală, astfel încât utilizatorii să înțeleagă că au găsit articolul potrivit, începând cu titlul său.

Exemplu: Anteturile Evernote sunt de înțeles, direcționate spre acțiune și scrise în limba utilizatorului.

Cum să scrieți o bază de cunoștințe tehnice pentru site-ul dvs., să dezvoltați documentația tehnică

formatarea

Creați un format standard care să asigure consistența și ușurința citirii. Utilizați, acolo unde este posibil, reguli utilizate în mod obișnuit. De exemplu, puteți determina că căile (care sunt date utilizatorilor pentru referință) trebuie întotdeauna să fie redactate după cum urmează:

Fișier> Salvare ca ...> Salvare ca jpg

Cum să scrieți conținut de bază de cunoștințe

Creați un proces transparent pentru persoanele care completează conținutul bazei de cunoștințe - acest lucru vă va ajuta să vă asigurați că noile probleme, probleme și soluții sunt întotdeauna înregistrate. Explicarea posibilităților poate fi făcută în mod diferit, dar întrebările și problemele sunt probabil conforme cu formatul standard al celor trei etape.

Acest lucru este foarte important pentru probleme. Asigurați-vă că includeți următoarele informații:

a) Care este problema? Asigurați-vă că includeți suficiente detalii în partea din descrierea problemei, astfel încât oamenii să știe că au găsit exact problema cu care se confruntă.

b) De ce se întâmplă acest lucru? Explicați ce a cauzat eroarea și furnizați pașii pe care îi veți lua pentru ao rezolva.

De unde știu dacă am aceeași problemă? Unele informații pe care doriți să le includeți în acest loc sunt mesaje de eroare sau circumstanțe precise cunoscute care duc la o problemă.

Apoi, descrieți răspunsul la întrebare sau rezolvați problema. Dacă soluția este complexă, rupeți-o în pași ușor de realizat, explicând fiecare termen tehnic.

Exemplu: Wistia include capturi de ecran în ajutorul său.

Cum să scrieți o bază de cunoștințe tehnice pentru site-ul dvs., să dezvoltați documentația tehnică

Se speră că majoritatea cititorilor vor găsi informațiile pe care le caută sau că vor rezolva problema, dar cei care nu o obțin, trebuie să ofere o ieșire. Unde pot solicita ajutor dacă soluția nu funcționează? Dacă oamenii trebuie să vă contacteze, faceți această ocazie evidentă. Este, de asemenea, o idee bună să plasați linkuri către probleme similare sau similare, deoarece acest lucru vă poate ajuta să rezolvați problema înainte de a apela serviciul clienți.

Cum să scrieți o bază de cunoștințe tehnice pentru site-ul dvs., să dezvoltați documentația tehnică

Sfaturi pentru scrierea tehnică

Utilizați o limbă simplă chiar și atunci când scrieți texte specifice pentru baza de utilizatori. Nimeni nu vrea să-și petreacă timpul încercând să treacă prin jargonul tehnic, toată lumea vrea să găsească o soluție la problema lor cât mai repede posibil.

Scrie pentru a citi de pe ecran

Conform următoarelor sfaturi pentru scrierea întrebărilor frecvente. trebuie să scrieți conținutul bazei de cunoștințe pentru a facilita citirea de pe ecran. Nu scrieți cu un bloc mare, împărțiți conținutul în părți pentru citirea ușoară a scanării.

Exemplu: Basecamp își împarte articolele în pași ușor de scanat.

Cum să scrieți o bază de cunoștințe tehnice pentru site-ul dvs., să dezvoltați documentația tehnică

Soluții de redresare și testare

Concluzie - păstrați-vă baza de cunoștințe într-o formă bună

De asemenea, ar putea fi interesat de:

  1. 111 surse de idei pentru blogul dvs. Blogul companiei - în lumea modernă acest lucru este un instrument necesar pentru.
  2. 13 fapte statistice despre copywriting pentru afacerea dvs. Articolul oferă o compilație de statistici privind diferite aspecte ale copywriting și.
  3. Actualizarea site-ului Dragi prieteni! Suntem bucuroși să anunțăm că site-ul nostru începe astăzi.
  4. Cum comunicatorii utilizează Doc-To-Help Recent, în magazinul nostru, a fost posibil să cumpărați un produs pe care să-l creați.
  5. Noi servicii pentru documentația dvs. De astăzi puteți utiliza noile noastre servicii: ajutor.