Deși ignorate frecvent de mulți utilizatori de computere, fișierele de ajutor oferă informații cheie despre modul de utilizare a aplicației software cu care sunt asociați. Dând clic pe „Ajutor”, un utilizator poate obține o prezentare generală a caracteristicilor programului, o descriere a ecranului la care se uită, instrucțiuni despre cum să utilizeze programul pentru a efectua o sarcină dată sau poate citi liste de întrebări frecvente despre programul și răspunsurile acestora. Scrierea unui fișier de ajutor necesită atât capacitatea de a lucra cu aplicații software, cât și capacitatea de a explica lucrurile într-un mod în care utilizatorii pot înțelege.
Pași
Pasul 1. Obțineți o copie a software-ului pe care urmează să îl documentați
Dacă este posibil, ar trebui să obțineți și o copie a specificațiilor scrise pentru program, deși nu toți dezvoltatorii de software lucrează cu ei. În unele cazuri, programatorul se va abate de la specificații, pe baza unui timp de dezvoltare scurt sau a imposibilității de a codifica o anumită caracteristică.
Pasul 2. Obțineți un instrument de creare a ajutorului
În timp ce este posibil să creați manual un fișier de ajutor, utilizând un fișier în format rich-text (.rtf), majoritatea autorilor de fișiere de ajutor folosesc o aplicație software pentru a scrie fișierele de ajutor, cum ar fi RoboHelp, Help and Manual, Doc-To -Ajutor, MadCap Flare sau HelpLogix. Majoritatea instrumentelor de creare a ajutorului includ un editor de text sau funcționează cu un program de procesare a textelor precum Microsoft Word și oferă o interfață cu utilizatorul care permite autorului de ajutor să vadă cum va arăta fișierul de ajutor pe măsură ce îl scrie în timp ce scrie codul computerului în culise. pentru a face ca fișierul de ajutor să funcționeze. Unele instrumente de creare a ajutorului includ, de asemenea, editori grafici pentru crearea capturilor de ecran pentru a fi incluse în fișierul de ajutor.
Există mai multe formate de fișiere de ajutor: cel mai frecvent este ajutorul HTML, care este utilizat de aplicațiile care rulează în Windows. (Un format mai vechi, WinHelp, nu mai este acceptat.) Fiecare dintre Apple și Unix au propriile lor formate, la fel ca și Sun Microsystems, cu JavaHelp. Aplicațiile software concepute pentru a rula sub mai multe sisteme de operare pot utiliza un sistem de ajutor multiplataforma care rulează în browserul web al utilizatorului. Orice instrument de creare a ajutorului pe care îl utilizați ar trebui să accepte formatul (formele) de ajutor în care doriți să creați fișiere de ajutor
Pasul 3. Creați fișierul de proiect de ajutor
Instrumentul dvs. de creare a ajutorului vă va crea un fișier de proiect de ajutor, pe baza numelui de fișier pe care îl furnizați și a altor informații. Fișierul principal al proiectului conține informații despre celelalte fișiere, care includ un fișier de conținut, un fișier index, unul sau mai multe fișiere imagine și alte fișiere.
- Fișierul conținut include textul din fișierul de ajutor care explică modul în care funcționează aplicația software pe care o documentați. Textul este de obicei împărțit în subiecte care acoperă un anumit ecran, caracteristică sau procedură.
- Fișierul index este o listă a subiectelor fișierului de ajutor. Este folosit pentru a crea un cuprins pe care utilizatorii îl pot folosi pentru a selecta un subiect de vizualizat, precum și un index care poate fi căutat în fișierul de ajutor.
- Fișierele imagine sunt fișiere grafice ale ecranelor programului sau porțiuni ale acelor ecrane afișate în fișierul de ajutor pentru a spori capacitatea utilizatorilor de a înțelege la ce se referă textul fișierului de ajutor.
Pasul 4. Reglați dimensiunea ferestrei de ajutor
Dacă nu scrieți fișierul de ajutor pentru a apărea în browserul web al utilizatorului, fișierul de ajutor va apărea în propria sa fereastră. Instrumentul dvs. de creare a ajutorului vă va permite să ajustați dimensiunile orizontale și verticale ale ferestrei la o dimensiune care să permită utilizatorului final să citească fișierul de ajutor fără ca acesta să împiedice aplicația în sine. Fereastra principală de ajutor este adesea într-un format tri-panou, cu cuprinsul în stânga și subiectul selectat în dreapta.
Fișierele de ajutor pot avea, pe lângă fereastra principală, ferestre secundare care descriu în detaliu o anumită caracteristică și dimensionează automat ferestrele pop-up care oferă scurte descrieri ale caracteristicilor. Fișierele de ajutor pot include, de asemenea, text încorporat care apare numai atunci când se evidențiază textul sau se face clic pe un buton
Pasul 5. Scrieți subiectele de ajutor
Pentru a face acest lucru, va trebui să revizuiți specificațiile sau programul în sine pentru a crea subiectele pentru a documenta ecranele și caracteristicile programului. Pe măsură ce creați fiecare subiect, instrumentul dvs. de creare a ajutorului îl va adăuga la cuprinsul și indexul fișierului de ajutor.
- În timp ce puteți construi un cuprins pe măsură ce mergeți, vă ajută să aveți un plan de organizare. Puteți organiza cuprinsul în jurul ecranelor programului, caracteristicile acestuia, modalitățile de utilizare sau o combinație a acestora.
- Pe măsură ce scrieți subiectele, luați în considerare alte informații din fișierul de ajutor la care utilizatorii vor dori să aibă acces rapid. Puteți crea salturi sau hyperlinkuri în textul fișierului de ajutor care se conectează la subiectele care au acele informații.
Pasul 6. Includeți capturi de ecran, dacă este necesar
Multe caracteristici ale programului sunt cel mai bine explicate cu o combinație de text și grafică. Puteți crea capturi de ecran fie cu aplicația care vine împreună cu instrumentul dvs. de creare a ajutorului, fie cu o aplicație separată, cum ar fi Microsoft Paint, Paint Shop Pro sau SnagIt.
- Textul și capturile de ecran ar trebui să fie prezentate împreună într-un subiect astfel încât utilizatorii să poată vedea captura de ecran și textul de susținere al acestuia fără a derula în mod nejustificat. În multe cazuri, veți dori să afișați o porțiune a ecranului programului în locul întregului ecran sau să afișați captura de ecran într-o dimensiune mai mică decât cea originală. Aplicația dvs. de captură de ecran ar trebui să poată redimensiona captura de ecran fără a estompa sau a pierde detaliile.
- Dacă anticipați modificări ale interfeței de utilizator între testul și versiunile finale ale programului, vă recomandăm să nu mai creați capturi de ecran până când veți avea versiunea finală a programului cu care să lucrați.
Pasul 7. Creați un fișier de hartă, dacă este necesar
Unele programe includ butoane „Ajutor” pentru ca un utilizator să facă clic și să afișeze subiectul în fișierul de ajutor care descrie în mod specific modul în care funcționează ecranul respectiv. Afișarea unui subiect în acest fel se numește ajutor contextual și necesită crearea unui fișier de hartă pentru ca programatorul să conecteze butonul „Ajutor” la subiectul specific din fișierul dvs. de ajutor. Instrumentul dvs. de creare a ajutorului poate crea unul pentru dvs. sau programatorul îl poate codifica și vă poate oferi pentru a include în fișierul de ajutor.
Pasul 8. Compilați fișierul de ajutor
Compilarea creează fișierul de ajutor real care va fi inclus în program. Pentru majoritatea formatelor de ajutor, acesta va încorpora toate fișierele componente care au fost create atunci când ați creat fișierul de ajutor, deși unele formate de ajutor necompilate necesită, de asemenea, fișierele individuale ale subiectului de ajutor pentru a fi incluse în program.
Pasul 9. Testați fișierul de ajutor
Odată ce ați compilat fișierul de ajutor, trebuie să-l testați pentru a vă asigura că toate hyperlinkurile se conectează la subiectele la care ar trebui să fie și toate graficele să fie afișate corect. Fișierul de ajutor trebuie, de asemenea, testat pentru a se asigura că conținutul este corect și adecvat pentru utilizatori și într-un format consistent. Veți dori să examinați singur fișierul de ajutor și să solicitați persoanelor care testează aplicația să îl revizuiască și.
În cazul proiectelor de fișiere de ajutor mai mari, compilarea și testarea sunt procese în desfășurare. Veți dori să compilați fișierul de ajutor și să vă verificați lucrările de mai multe ori înainte de a crea versiunea finală
Pasul 10. Dă fișierul de ajutor dezvoltatorului pentru a-l include în program
În funcție de natura proiectului și formatul fișierului de ajutor, poate fi necesar să furnizați dezvoltatorului mai multe fișiere, inclusiv un fișier hartă, dacă există subiecte sensibile la context.
