Fă drept! Publicăm documentația online pe site-ul proiectului

Formatul documentației online

Cele mai moderne programe HAT, cum ar fi Dr.Explain. sunt capabili să creeze documente în diverse formate (de exemplu, webhelp și PDF) dintr-un proiect sursă fără costuri suplimentare de muncă din partea dvs.

Un alt punct important care trebuie notat este utilizarea cadrelor. Acum mulți ani, când tehnologia de conținut dinamic (AJAX, HTML5, etc) au fost în fază incipientă lor, cadre părea o bună modalitate de a diviza de lucru a ferestrei browser-ului în zone funcționale - titlul, cuprins, zona de conținut etc. Cu toate acestea, acum nu este prea important să le folosiți. Acestea dau naștere, mai probabil, mai multe probleme, decât să dea avantaje. Printre problemele pot fi identificate, cum ar fi - o navigare complicată și gradul de utilizare, inconvenientul de utilizare în browsere mobile, potențiale probleme cu optimizarea motorului de căutare (SEO). Aproape toate programele moderne pentru crearea de documentație sunt capabile să creeze webhelp fără a folosi cadre fără a compromite confortul de a lucra cu documentația.

Navigare în documentație

Prin urmare, este important să se arate o astfel de „picătură de“ utilizator, în care secțiunea este în cazul în care această secțiune este structura generală a proiectului, care sunt subiectele legate pe care le puteți vedea în continuare și, în general vorbind, la orice documentație de proiect citește de fapt. Toate aceste sarcini pot fi ușor rezolvate prin organizarea unei bune navigări pe documentație.

Imaginea de ecran se face cu ajutorul instrumentelor integrate ale programului Dr.Explain

Cuprins

Conținutul documentației ar trebui să fie disponibil pe oricare dintre paginile sale. Cuprinsul conține imediat structura documentului, poziția secțiunii curente și, cel mai important, vă permite să sari imediat la alte secțiuni. Nu permiteți situația când conținutul este realizat de o pagină de bază separată a documentului. În acest caz, utilizatorul trebuie să se întoarcă în mod constant la tabelul de conținut rădăcină, apoi să treacă la o altă secțiune. Acest lucru este incomod. De obicei, un astfel de dezavantaj structural este documentația creată pe platformele wiki.

"Paine de pâine" (pâine)

"Breadcrumbs" afișează lista secțiunilor părinte pentru această pagină. Cu ajutorul lor, utilizatorul poate înțelege rapid care dintre secțiunile globale include un anumit subiect și faceți clic pentru a merge la unul dintre ele.

Navigare liniară

Legăturile către paginile următoare și către cele anterioare sunt convenabile atunci când citiți secvențial documentația, mai ales dacă cuprinsul este foarte mare. Navigarea liniară salvează utilizatorul de faptul că trebuie să caute tema curentă în arborele secțiunilor de fiecare dată și apoi să încerce să înțeleagă ce subiect este următorul.

Secțiuni și subsecțiuni înrudite

În partea de jos a paginii se poate afișa o listă cu subiectele aferente ("Vezi și") și o listă cu subsecțiunile subiectului curent. Această "compilare" ajută utilizatorul să găsească rapid informații suplimentare privind problema de interes, fără a recurge la funcția de căutare.

Branding și integrarea cu site-ul proiectului

Ușurința de utilizare

Din fericire, programe profesionale de dezvoltare a documentației, cum ar fi Dr.Explain. sunt capabili să creeze un ajutor online cu un design complet adaptabil, care să susțină simultan atât aspectul tradițional, cât și cel mobil. Această documentație este convenabilă pentru a fi utilizată atât pe un computer staționar cât și pe dispozitivele mobile.

Interacțiunea cu utilizatorii

În plus față de obiectivul principal - de a ajuta utilizatorii să lucreze cu produsul - documentația poate servi, de asemenea, ca un instrument de marketing și un mijloc de comunicare cu utilizatorii.

Optimizarea motorului de căutare (SEO)

Luând în considerare funcția de marketing a documentației online, și anume utilizați-l pentru a atrage noi utilizatori și pentru a promova produsul pe piață, este imposibil să nu menționăm problema SEO (Search Engine Optimization).

Documentația online reprezintă o gamă imensă de informații care descriu soluția unei anumite clase de sarcini cu ajutorul produsului dvs. Persoanele care caută soluții la aceste activități pe Internet, dar care nu sunt încă familiarizate cu proiectul dvs., sunt potențialii dvs. utilizatori. După ce ați citit în documentația dvs. cum pot fi rezolvate sarcinile prin utilizarea funcțiilor produsului dvs., probabil că vor să-l folosească. Singura modalitate de a obține astfel de persoane este să vă asigurați că motoarele de căutare sunt Google, Yandex, Bing etc. - emise cât mai des posibil și mai aproape de începutul listei de linkuri către paginile ajutorului dvs. online, pe fraze legate de descrierea problemelor utilizatorului. De exemplu, "cum să optimizați paleta de imagini PNG fără a pierde calitatea".

Detaliile tehnice ale optimizării motorului de căutare a documentației trebuie să fie dedicate unui articol separat. În primul rând, vă puteți concentra pe principiile de bază ale transmiterii corecte a informațiilor.

Ei bine structurați informațiile. Împărțiți conținutul în secțiuni și subiecte semantice complete care descriu soluția de sarcini specifice. Nu faceți subiecte lungi care descriu prea mult dintr-o dată. Informațiile de pe fiecare pagină trebuie să fie clare și concentrate.

În interiorul paginii, adera și la o structură clară. Utilizați subtitrări informative de diferite nivele, liste numerotate și enumerări. Încercați să utilizați în subpozițiile cuvinte cheie legate de descrierea problemei care trebuie rezolvată. Nu fi leneș pentru a semna pe deplin imagini, tabele, diagrame.

Re-legați paginile de documentație. Pune în secțiunea link-uri de text la alte secțiuni ale documentației, trimiterile din text, folosiți fraze-cheie (de exemplu, „Redimensionare imagine“), și nu cuvintele dummy (de exemplu, „click aici“ sau „aici“).

Creați fiecare subiect într-un fișier separat, cu cuvinte cheie în numele fișierului. Fiecare subiect al ajutorului dvs. online ar trebui să aibă un nume de fișier unic și, în final, o adresă URL unică, astfel încât motorul de căutare să se poată referi la acesta. Pentru a îmbunătăți clasarea paginii dvs. în motorul de căutare, oferiți-i un nume semnificativ. De exemplu, reducerea dimensiunii imaginii prin limită-colors.html este mai preferabilă decât "page_34-838-b.htm". Apropo, Dr.Explain generează automat nume de fișiere bazate pe numele subiectului. Este convenabil.

locație

Plasați fișierele de ajutor într-un director separat de pe site-ul Web al produsului. Pentru utilizatorii dvs. va fi mai ușor să acceseze documentația și vă va fi mai ușor să o întrețineți și să o actualizați, deoarece fișierele de ajutor online nu vor fi amestecate cu fișierele altor secțiuni ale site-ului.

disponibilitate

Această problemă este ușor de eliminat. Este suficient să adăugați linkuri către documentația din meniul principal al site-ului, precum și pe paginile de suport și descrieri ale funcționalității proiectului.

Nu permiteți o situație în care utilizatorul nu poate găsi documentația însuși și singura șansă de accesare a acesteia este să o solicitați direct în asistența tehnică.

Urmați aceste principii și vă veți transforma documentația online dintr-o grămadă de texte plictisitoare într-un instrument puternic pentru suport tehnic, comunicare cu utilizatorii și promovarea proiectului dvs. pe piață. Și nu este greu să urmezi aceste principii. Programe specializate pentru crearea documentației de utilizare, cum ar fi Dr.Explain. vă va rezolva majoritatea problemelor tehnice și vă va permite să vă concentrați asupra celor mai importante - asupra utilizatorilor și asupra proiectului dvs.

DOWNLOAD
GRATUIT
45Mb (ZIP), Windows Vista, 7, 8, 10 - 64 de biți