Documentația produsului Ghid definitiv: tot ce trebuie să știți pentru a crea documente grozave

Documentația produsului... s-ar putea să nu fie cea mai sexy parte a conducerii unei afaceri, dar este un domeniu cheie pe care nu ar trebui să îl treceți cu vederea dacă doriți ca afacerea dvs. să aibă succes.

Crearea de documentație de înaltă calitate a produsului vă poate ajuta să vă faceți clienții mai de succes, să vă reduceți sarcina de asistență și, în general, să construiți o afacere mai bună.

Dar ce se întâmplă în crearea documentației produsului? Și cum vă puteți configura propria documentație pe site-ul dvs. web?

Acestea sunt doar câteva dintre întrebările la care vom răspunde în ghidul nostru final pentru documentația produsului. Iată tot ce vom acoperi:

• De ce ar trebui să vă pese de strategia de documentare a produsului
• Câteva exemple reale de documentație de top
• Cel mai bun software de documentare a produsului
• Opt sfaturi pentru crearea unei documentații mai bune

Sunteți gata să îmbunătățiți modul în care afacerea dvs. gestionează documentația? Să pătrundem!

De ce ar trebui să vă pese de strategia de documentare a produsului dvs

Să începem lucrurile cu o privire la motivul pentru care nu ar trebui să vă zgârciți cu strategia de documentare a produsului.

Îți face clienții mai de succes

Cel mai mare beneficiu al creării documentației de produs este că îi face clienții mai de succes. A avea mai mulți clienți de succes înseamnă rate de conversie mai mari, rate de abandon mai mici și așa mai departe.

Are sens – dacă un client nu își poate da seama cum să obțină valoare din produsul tău, nu va rămâne client pentru foarte mult timp.

Documentația produsului este o modalitate utilă de a educa clienții, astfel încât aceștia să obțină cât mai multă valoare posibil. Când primesc mai multă valoare de la produsul dvs., vor fi mai probabil să continue să plătească, să vă recomande prietenilor/colegilor lor și așa mai departe.

Îți reduce sarcina de sprijin

Documentația produsului poate fi, de asemenea, o modalitate excelentă de a reduce sarcina asupra canalelor dumneavoastră de asistență umană.

Dacă documentația produsului dvs. este de calitate scăzută sau inexistentă, înseamnă că clienții dvs. trebuie să contacteze echipa de asistență umană de fiecare dată când există o problemă. Aceasta înseamnă mai mult timp petrecut pentru a răspunde solicitărilor de asistență.

Fie va trebui să vă luați timp de la dezvoltarea afacerii pentru a gestiona singuri aceste răspunsuri, fie va trebui să angajați o persoană de asistență dedicată ( care costă bani ).

Cu o documentație de înaltă calitate, clienții vor putea să-și rezolve multe dintre propriile probleme, ceea ce elimină nevoia de a solicita asistență. De asemenea, vă puteți structura procesele de asistență pentru a împinge oamenii să vă verifice documentația înainte de a face o solicitare.

Poate fi un instrument bun de marketing și vânzări

În timp ce mulți oameni se gândesc la documentarea produsului în contextul ajutorării persoanelor care au decis deja să facă o achiziție, o documentare bună a produsului vă poate ajuta, de asemenea, să atrageți și să convertiți mai mulți clienți în primul rând.

Din punct de vedere al marketingului, documentația de produs este o mină de aur de cuvinte cheie SEO cu coadă lungă pentru care vă puteți clasifica documentația. S-ar putea să fii surprins de numărul de persoane care ajung direct pe documentația produsului de la Google. Dacă vă structurați bine documentația, veți avea șansa de a converti acești oameni în clienți.

Documentația dvs. poate fi, de asemenea, un instrument de vânzări util pentru persoanele care se află pe un gard în privința achiziționării produsului dvs. Documentația produsului poate răspunde întrebărilor potențiale de prevânzare pe care le-ar putea avea, îi poate convinge că produsul dvs. poate face ceea ce au nevoie și le poate oferi încredere că vor primi ajutor atunci când au nevoie.

De exemplu, Stripe este cunoscut pentru că are unele dintre cele mai bune documentații ale produsului. Dacă accesați Twitter, puteți vedea o mulțime de oameni care recomandă Stripe din cauza calității documentației Stripe:

Îți face angajații mai eficienți

Documentația de produs nu este doar pentru clienți, ci poate fi, de asemenea, o resursă importantă pentru membrii echipei dvs. pentru a afla despre produsul dvs. și de referință atunci când este necesar. Acest lucru este valabil mai ales pentru noii angajați, care ar putea să nu aibă o bază largă de cunoștințe despre produsul dvs.

Patru exemple grozave de documentație de produs din viața reală

Pentru a vă oferi mai multă inspirație, să ne uităm la câteva exemple de documentație de produs din lumea reală de la companii de succes.

1. Dungă

Am menționat Stripe mai devreme ca fiind unul dintre cele mai bune exemple de documentație de calitate ca instrument de marketing/vânzări, așa că știți că documentația Stripe trebuia să fie numărul unu pe lista noastră.

2. Adyen

Adyen este o platformă de plăți pentru comerțul electronic, plăți mobile și la punctul de vânzare. La fel ca Stripe, asta înseamnă că dezvoltatorii trebuie să îl integreze în propriile platforme, ceea ce necesită o documentare excelentă. Adyen nu dezamăgește – consultați documentația completă Adyen aici.

3. Twilio

Dacă nu sunteți familiarizat cu Twilio, este un instrument care ajută companiile să construiască comunicarea în platformele lor, prin mesaje text, e-mailuri, apeluri telefonice și multe altele. Ca și în cazul Stripe și Adyen, acest lucru înseamnă că companiile vor trebui să integreze Twilio în serviciile lor existente, ceea ce necesită documentație de top. Puteți răsfoi documentele Twilio pentru a vedea un exemplu grozav.

4. slăbiciune

Slack este un alt instrument care are o documentație foarte bine scrisă și utilă. Puteți răsfoi întreaga documentație Slack aici.

Pentru a vedea mai multe exemple, consultați postarea noastră completă despre cele mai bune exemple de documentație pentru utilizator.

Cel mai bun software de documentare a produsului

Acum, să trecem la modul în care puteți începe să oferiți o documentație mai bună a produsului pe site-ul dvs.

Vom vorbi despre scrierea efectivă a documentației în secțiunea următoare. Cu toate acestea, înainte de a vă putea scrie documentația, aveți nevoie de un loc în care să stocați acele articole și să le faceți accesibile utilizatorilor dvs.

Deși puteți doar să adăugați aceste articole direct pe site-ul dvs., este o idee mult mai bună să utilizați un software dedicat pentru documentarea produsului. Dincolo de organizarea conținutului și de a-l face accesibil vizitatorilor, un software bun de documentare a produsului va include și alte caracteristici utile, cum ar fi...

• Funcțiile de căutare Ajax pentru a ajuta vizitatorii să răsfoiască documentația.
• Căutați analize, astfel încât să puteți vedea ce subiecte caută oamenii.
• Date de utilitate, astfel încât să puteți urmări cât de util este fiecare articol și să vă îmbunătățiți atunci când este necesar.

Iată două dintre cele mai bune soluții...

Baza de cunoștințe eroică (KB eroic)

Heroic Knowledge Base este un plugin pentru software-ul gratuit, cu sursă deschisă WordPress, care vă permite să vă creați cu ușurință propriul centru de documentare a produsului găzduit de sine.

Dacă utilizați deja WordPress pentru site-ul web al companiei dvs., puteți adăuga Heroic Knowledge Base pe site pentru a vă crea propriul centru de documentare. Sau, dacă nu, puteți crea o instalare WordPress dedicată pentru documentația dvs. În acest din urmă caz, s-ar putea să fiți interesat și de tema de documentație KnowAll WordPress .

Baza de cunoștințe eroică vă permite să adăugați toată documentația folosind editorul de conținut WordPress, ceea ce facilitează includerea conținutului multimedia dacă este necesar. Veți avea, de asemenea, acces la sistemul încorporat de versiune a conținutului WordPress, care vă permite să urmăriți cu ușurință modificările și să comparați versiunile anterioare ale documentației dvs.

Baza de cunoștințe eroică adaugă și o serie de caracteristici utile, inclusiv:

• Căutare instantanee Ajax.
• Analize de căutare.
• Evaluări de utilitate ale articolului.
• Atașamente la fișierul articol.

Baza de cunoștințe eroică costă doar 129 USD.

Adobe RoboHelp

Dacă vă publicați documentația doar pe web, o soluție precum Heroic Knowledge Base este tot ce aveți nevoie. Cu toate acestea, pentru mai multe necesități de documentare la nivel de întreprindere, este posibil să aveți situații în care trebuie să vă publicați documentația pe mai multe platforme, inclusiv web, hârtie fizică, aplicații mobile, PDF-uri și așa mai departe.

În acest caz, este posibil să preferați un instrument de creație a documentației cu mai multe platforme, cum ar fi Adobe RoboHelp. Începând de la 29,99 USD pe lună pentru utilizare individuală, este mai scump decât Heroic Knowledge Base. Cu toate acestea, dacă aveți nevoie de creație pe mai multe platforme, acest preț suplimentar ar putea merita banii.

Cum să optimizați structura și conținutul documentației produsului

Acum că aveți software-ul necesar pentru a vă gestiona documentația, să vorbim despre cum puteți scrie articole de înaltă calitate. Iată opt sfaturi cheie pentru a vă structura documentația și pentru a scrie articole de ajutor mai bune...

1. Înțelege-ți publicul

Pentru a scrie o documentație excelentă a produsului, trebuie să înțelegeți publicul pentru care scrieți (adică clienții dvs.).

Pentru cine scrieți va afecta informațiile pe care le includeți și modul în care structurați totul. De exemplu, dacă scrieți pentru dezvoltatori, documentația dvs. ar trebui să fie radical diferită de cea scrisă pentru utilizatorii ocazionali.

Nu doriți să presupuneți că audiența dvs. este experți și trece peste detalii cheie, dar ați putea presupune anumite cunoștințe de bază, în funcție de cine sunt.

2. Înțelegeți diferitele tipuri de documentație de produs

Există diferite tipuri de documentație de produs și fiecare necesită o abordare diferită. Unele dintre tipurile comune sunt:

• Prezentare generală – aceste articole oferă o imagine de ansamblu asupra modului în care funcționează o zonă a produsului dvs., cum ar fi un ghid „Noțiuni introductive”.
• Tutoriale pas cu pas – aceste articole arată oamenilor cum să efectueze o anumită sarcină.
• Referință - aceste articole explică concepte specifice din produsul dvs.
• Depanare – aceste articole explică cum să depanați/depanați problemele comune pe care le-ar putea întâlni clienții.

Tipul de documentație la care lucrați ar trebui să afecteze modul în care scrieți și modul în care vă structurați documentația, așa că este important să știți care este scopul înainte de a vă concentra.

3. Fii consecvent în stilul tău și convențiile de denumire

Pentru a facilita utilizarea documentației produsului de către clienți, este important să păstrați același stil și convenții de denumire în întreaga documentație. Acest lucru va face mai ușor pentru clienți să urmărească documentația dvs. și va evita orice potențială confuzie.

Pentru a vă ajuta să faceți acest lucru, ar putea fi util să veniți cu un ghid de stil pentru formatarea și terminologia de bază.

4. Folosiți un limbaj simplu și rămâneți concis

Toate lucrurile egale, limbajul scurt, simplu este întotdeauna mai bun decât salata de cuvinte. Scopul tău ar trebui să fie să comunici toate informațiile necesare în cât mai puține cuvinte posibil.

De asemenea, ar trebui să evitați utilizarea jargonului sau a termenilor complexi ori de câte ori este posibil. Nu toți clienții dvs. vor avea aceeași bază de cunoștințe și unii ar putea să nu fie vorbitori nativi ai limbii documentației dvs., așa că păstrarea lucrurilor cât mai simple posibil vă asigură că toată lumea poate obține valoare din documentația dvs.

5. Organizați documentația în articole logice, „de dimensiunea problemei”.

Pentru ca oamenii să răsfoiască mai ușor documentația dvs. și să găsească articole pentru problemele lor specifice, trebuie să vă împărțiți documentația în segmente logice. În general, fiecare articol ar trebui să se concentreze pe rezolvarea unei probleme specifice.

Desigur, ar putea exista mai multe sub-probleme în cadrul acelei probleme principale, dar ideea este că nu doriți să grupați două probleme complet separate în același articol, deoarece le va fi dificil pentru oameni să caute acele subiecte și ei. ar putea fi confuzi când aterizează pe articol.

Clienții dvs. nu vă vor citi documentația într-o manieră liniară, așa cum ar citi o carte. În schimb, vor sări în funcție de problema cu care se confruntă în acest moment. Împărțirea articolelor în segmente logice vă ajută să luați în considerare acest comportament.

6. Încorporați elemente multimedia

Deși textul scris ar trebui să formeze nucleul documentației produsului, nu ar trebui să fie singurul lucru. De asemenea, poate fi util să includeți conținut imagine și video acolo unde are sens.

Dacă includeți capturi de ecran, puteți adăuga și adnotări la imagini pentru a clarifica detaliile cheie.

7. Utilizați titluri și adăugați un cuprins

În cadrul articolelor individuale de documentare a produsului, asigurați-vă că utilizați titluri pentru a vă împărți articolele în segmente logice, în loc să scrieți doar un perete lung de text.

Pentru a ajuta oamenii să navigheze în articol, puteți adăuga și un cuprins care le permite cititorilor să sară rapid la o anumită secțiune.

Unele software de documentare a produsului vă pot ajuta să adăugați automat un cuprins. De exemplu, pluginul Heroic Knowledge Base vine cu o funcție încorporată pentru a genera automat un cuprins bazat pe titlurile fiecărui articol.

8. Îmbunătățiți și actualizați întotdeauna documentația

În cele din urmă, este important să ne amintim că crearea documentației produsului nu este un eveniment unic; este un proces continuu.

La un nivel de bază, produsul dvs. va suferi probabil modificări, așa că este important să vă actualizați documentația pentru a ține cont de acele modificări și de orice caracteristici noi pe care le-ați adăugat.

Dar, dincolo de asta, dacă alegeți un software de documentare a produsului, cum ar fi Heroic Knowledge Base, veți avea acces la analize pentru a vă ajuta să înțelegeți modul în care oamenii vă folosesc documentația. Puteți utiliza aceste analize pentru a:

1. Urmăriți ceea ce caută oamenii, ceea ce poate fi un semn că trebuie să creați documentație în jurul acestor subiecte, dacă nu ați făcut-o deja.
2. Vedeți ce articole nu ajută utilizatorii atât de mult pe cât ați dori, ceea ce ar putea fi un semn că trebuie să aduceți îmbunătățiri la articolele respective pentru a le îmbunătăți utilitatea.

Începeți să creați o documentație minunată de produs astăzi!

Crearea documentației de înaltă calitate a produsului este o investiție în succesul pe termen lung al afacerii dumneavoastră. Te ajută…

• Fă-ți clienții mai de succes.
• Reduceți sarcina echipei dumneavoastră de asistență.
• Atrageți și convertiți mai mulți clienți în primul rând.
• Îmbunătățiți cunoștințele angajaților despre produsul dvs.

În această postare, am împărtășit câteva exemple grozave de documentație de produs de la companii de succes, împreună cu câteva sfaturi despre cum să scrieți și să structurați documentația.

Dacă sunteți gata să vă creați propriul centru de documentare a produsului, puteți utiliza pluginul Heroic Knowledge Base pentru a vă crea propria soluție auto-găzduită, alimentată de WordPress. Faceți clic pentru a afla mai multe despre Heroic Knowledge Base.