Edhe pse shpesh shpërfillen nga shumë përdorues të kompjuterit, skedarët e ndihmës japin informacion kyç në lidhje me mënyrën e përdorimit të aplikacionit të softuerit me të cilin shoqërohen. Duke klikuar "Ndihmë", një përdorues mund të marrë një përmbledhje të veçorive të programit, një përshkrim të ekranit që ai ose ajo po shikon, udhëzime se si të përdoret programi për të kryer një detyrë të caktuar ose të lexojë listat e pyetjeve të shpeshta në lidhje me programi dhe përgjigjet e tyre. Shkrimi i një skedari ndihme kërkon aftësinë për të punuar me aplikacione softuerike dhe aftësinë për të shpjeguar gjërat në një mënyrë që përdoruesit mund të kuptojnë.
Hapa
Hapi 1. Merrni një kopje të softuerit që do të dokumentoni
Nëse është e mundur, ju gjithashtu duhet të merrni një kopje të specifikimeve të shkruara për programin, megjithëse jo të gjithë zhvilluesit e softuerit punojnë me ta. Në disa raste, programuesi do të devijojë nga specifikimet, bazuar në kohën e shkurtër të zhvillimit ose duke mos qenë në gjendje të kodojë një veçori të veçantë.
Hapi 2. Merrni një mjet për të shkruar ndihmën
Ndërsa është e mundur të krijoni një skedar ndihme me dorë, duke përdorur një skedar me tekst të pasur (.rtf), shumica e autorëve të skedarëve të ndihmës përdorin një aplikacion softuer për të shkruar skedarët e tyre të ndihmës, të tilla si RoboHelp, Help and Manual, Doc-To -Ndihmë, MadCap Flare ose HelpLogix. Shumica e mjeteve të krijimit të ndihmës përfshijnë një redaktues teksti ose punë me një program të përpunimit të fjalëve si Microsoft Word dhe sigurojnë një ndërfaqe përdoruesi që lejon autorin e ndihmës të shohë se si do të duket skedari i ndihmës ndërsa ai ose ajo po e shkruan atë ndërsa shkruan kodin e kompjuterit prapa skenave për ta bërë dosjen e ndihmës të funksionojë. Disa mjete ndihmëse për të shkruarit përfshijnë gjithashtu redaktues grafikë për krijimin e pamjeve të ekranit për t'u përfshirë në skedarin e ndihmës.
Ekzistojnë një numër i formateve të skedarëve të ndihmës: Më e zakonshme është HTML Help, e cila përdoret nga aplikacionet që funksionojnë në Windows. (Një format më i vjetër, WinHelp, nuk mbështetet më.) Apple dhe Unix secili kanë formatet e tyre, si dhe Sun Microsystems, me JavaHelp -in e tij. Aplikacionet softuerike të krijuara për të funksionuar nën disa sisteme operative mund të përdorin një sistem ndihmës ndër-platformë që funksionon në shfletuesin e uebit të përdoruesit. Cilado mjet ndihmës për të shkruar ju duhet të përdorni formatin e ndihmës në të cilin do të krijoni skedarë ndihme
Hapi 3. Krijoni skedarin e projektit të ndihmës
Mjeti juaj i krijimit të ndihmës do të krijojë një skedar projekti ndihme për ju, bazuar në emrin e skedarit që jepni dhe informacione të tjera. Skedari kryesor i projektit përmban informacion në lidhje me skedarët e tjerë, të cilët përfshijnë një skedar të përmbajtjes, një skedar indeksi, një ose më shumë skedarë imazhi dhe skedarë të tjerë.
- Skedari i përmbajtjes përfshin tekstin në skedarin e ndihmës që shpjegon se si funksionon aplikacioni i softuerit që po dokumentoni. Teksti zakonisht ndahet në tema që mbulojnë një ekran, veçori ose procedurë të veçantë.
- Skedari indeks është një listë e temave të skedarit të ndihmës. Përdoret për të krijuar një tabelë të përmbajtjes që përdoruesit mund të përdorin për të zgjedhur një temë për të parë, si dhe një indeks të kërkueshëm brenda skedarit të ndihmës.
- Skedarët e imazhit janë skedarë grafikë të ekraneve të programit ose pjesë të atyre ekraneve të shfaqur brenda skedarit të ndihmës për të rritur aftësinë e përdoruesve për të kuptuar se për çfarë i referohet teksti i skedarit të ndihmës.
Hapi 4. Rregulloni madhësinë e dritares së ndihmës
Nëse nuk jeni duke shkruar skedarin e ndihmës që të shfaqet në shfletuesin e uebit të përdoruesit, skedari i ndihmës do të shfaqet në dritaren e vet. Mjeti juaj i krijimit të ndihmës do t'ju lejojë të rregulloni dimensionet horizontale dhe vertikale të dritares në një madhësi që do t'i lejojë përdoruesit përfundimtar të lexojë skedarin e ndihmës pa u penguar në vetë aplikacionin. Dritarja kryesore e ndihmës është shpesh në një format tri-panel, me tabelën e përmbajtjes në të majtë dhe temën e zgjedhur në të djathtë.
Skedarët e ndihmës gjithashtu mund të kenë, përveç dritares kryesore, dritare dytësore që përshkruajnë një veçori të veçantë në detaje dhe madhësi automatike të dritareve që japin përshkrime të shkurtra të veçorive. Skedarët e ndihmës gjithashtu mund të përfshijnë tekst të ngulitur që shfaqet vetëm kur teksti i theksuar ose klikohet një buton
Hapi 5. Shkruani temat e ndihmës
Për ta bërë këtë, do t'ju duhet të rishikoni specifikimet ose vetë programin për të krijuar tema për të dokumentuar ekranet dhe veçoritë e programit. Ndërsa krijoni secilën temë, mjeti juaj i krijimit të ndihmës do ta shtojë atë në tabelën e përmbajtjes dhe indeksit të skedarit të ndihmës.
- Ndërsa mund të ndërtoni tabelën e përmbajtjes ndërsa ecni, ju ndihmon të keni një plan se si ta organizoni atë. Ju mund të organizoni tabelën e përmbajtjes rreth ekraneve të programit, veçoritë e tij, mënyrat e përdorimit të tij ose ndonjë kombinim të tyre.
- Ndërsa shkruani temat, merrni parasysh informacione të tjera në skedarin e ndihmës në të cilat përdoruesit do të duan të kenë qasje të shpejtë. Ju mund të krijoni kërcime, ose hiperlidhje, në tekstin e skedarit të ndihmës që lidhen me temat që kanë atë informacion.
Hapi 6. Përfshini pamjet e ekranit, nëse është e nevojshme
Shumë veçori të programit shpjegohen më së miri me një kombinim të tekstit dhe grafikës. Mund të krijoni pamje të ekranit ose me aplikacionin që vjen me mjetin tuaj të ndihmës për të shkruar ose me një aplikacion të veçantë, të tillë si Microsoft Paint, Paint Shop Pro ose SnagIt.
- Teksti dhe pamjet e ekranit duhet të vendosen së bashku në një temë të tillë që përdoruesit të mund të shohin pamjen e ekranit dhe tekstin e tij mbështetës pa lëvizje të panevojshme. Në shumë raste, do të dëshironi të shfaqni një pjesë të ekranit të programit në vend të të gjithë ekranit, ose të shfaqni pamjen e ekranit në një madhësi më të vogël se origjinali. Aplikacioni juaj i ekranit duhet të jetë në gjendje të ndryshojë madhësinë e pamjes së ekranit pa mjegullim ose humbje të detajeve.
- Nëse parashikoni ndryshime në ndërfaqen e përdoruesit midis testit dhe versioneve përfundimtare të programit, mund të dëshironi të ndaloni krijimin e pamjeve të ekranit derisa të keni versionin përfundimtar të programit për të punuar.
Hapi 7. Krijoni një skedar harte, nëse është e nevojshme
Disa programe përfshijnë butona "Ndihmë" që një përdorues të klikojë dhe të shfaqë temën në skedarin e ndihmës që përshkruan në mënyrë specifike se si funksionon ai ekran. Shfaqja e një teme në këtë mënyrë quhet ndihmë e ndjeshme ndaj kontekstit dhe kërkon krijimin e një skedari harte për programuesin që të lidhë butonin "Help" me temën specifike në skedarin tuaj të ndihmës. Mjeti juaj i krijimit të ndihmës mund të krijojë një për ju, ose programuesi mund ta kodojë atë dhe t’ju japë që ta përfshini në skedarin e ndihmës.
Hapi 8. Përpiloni skedarin e ndihmës
Përpilimi krijon skedarin aktual të ndihmës që do të përfshihet në program. Për shumicën e formateve të ndihmës, kjo do të përfshijë të gjithë skedarët përbërës që u krijuan kur krijuat skedarin e ndihmës, edhe pse disa formate ndihme të pakompiluara kërkojnë që skedarët e temave të ndihmës individuale të përfshihen në program.
Hapi 9. Testoni skedarin e ndihmës
Pasi të keni përpiluar skedarin e ndihmës, duhet ta provoni për t'u siguruar që të gjitha lidhjet lidhëse të lidhen me temat për të cilat ata supozohen dhe të gjitha grafikat të shfaqen në mënyrë korrekte. Skedari i ndihmës gjithashtu duhet të testohet për të siguruar që përmbajtja është e saktë dhe e përshtatshme për përdoruesit dhe në një format të qëndrueshëm. Ju do të dëshironi të rishikoni dosjen e ndihmës vetë dhe t'i bëni njerëzit që testojnë aplikacionin ta rishikojnë atë gjithashtu.
Në projektet më të mëdha të skedarëve të ndihmës, përpilimi dhe testimi janë procese të vazhdueshme. Ju do të dëshironi të përpiloni skedarin e ndihmës dhe të kontrolloni punën tuaj disa herë para se të krijoni versionin përfundimtar
Hapi 10. Jepni skedarin e ndihmës zhvilluesit që ta përfshijë me programin
Në varësi të natyrës së projektit dhe formatit të skedarit të ndihmës, mund t'ju duhet të siguroni zhvilluesit disa skedarë, përfshirë skedarin e hartës nëse ka tema të ndjeshme ndaj kontekstit.
