Alhoewel baie rekenaargebruikers dit gereeld ignoreer, bied hulplêers belangrike inligting oor die gebruik van die sagtewaretoepassing waarmee dit verband hou. Deur op "Help" te klik, kan 'n gebruiker 'n oorsig kry van die funksies van die program, 'n beskrywing van die skerm waarna hy of sy kyk, instruksies oor hoe om die program te gebruik om 'n gegewe taak uit te voer, of lyste te lees met algemene vrae oor die program en hul antwoorde. Om 'n hulplêer te skryf, vereis beide die vermoë om met sagtewaretoepassings te werk en die vermoë om dinge te verduidelik op 'n manier wat gebruikers kan verstaan.
Stappe
Stap 1. Kry 'n afskrif van die sagteware wat u gaan dokumenteer
Indien moontlik, moet u ook 'n afskrif van die geskrewe spesifikasies vir die program kry, hoewel nie alle sagteware -ontwikkelaars daarmee saamwerk nie. In sommige gevalle sal die programmeerder afwyk van die spesifikasies, gebaseer op 'n kort ontwikkelingstyd of as hy nie 'n spesifieke funksie kan kodeer nie.
Stap 2. Verkry 'n hulp -outeur -hulpmiddel
Alhoewel dit moontlik is om 'n hulplêer met die hand te maak, met behulp van 'n ryk-teks-formaat (.rtf) lêer, gebruik die meeste hulp-outeurs 'n sagtewaretoepassing om hul hulplêers te skryf, soos RoboHelp, Help and Manual, Doc-To -Help, MadCap Flare of HelpLogix. Die meeste hulpverleningshulpmiddels bevat 'n teksredakteur of werk met 'n woordverwerkingsprogram soos Microsoft Word en bied 'n gebruikerskoppelvlak waarmee die hulpskrywer kan sien hoe die hulplêer sal lyk terwyl hy of sy dit skryf terwyl hy rekenaarkode agter die skerms skryf om die hulplêer te laat werk. Sommige hulpmiddels vir die skryf van hulpmiddels bevat ook grafiese redakteurs vir die maak van skermkiekies wat in die hulplêer ingesluit moet word.
Daar is 'n aantal hulplêerformate: Die algemeenste is HTML Help, wat gebruik word deur programme wat in Windows gebruik word. ('N Ouer formaat, WinHelp, word nie meer ondersteun nie.) Apple en Unix het elk hul eie formate, net soos Sun Microsystems, met sy JavaHelp. Sagtewaretoepassings wat ontwerp is om onder verskillende bedryfstelsels te werk, kan 'n kruis-platformhulpstelsel gebruik wat in die gebruiker se webblaaier loop. Ongeag watter hulpverleningshulpmiddel u gebruik, moet die hulpformate (e) ondersteun waarin u hulplêers gaan skep
Stap 3. Skep die hulpprojeklêer
U hulp -outeur sal 'n hulpprojeklêer vir u skep, gebaseer op die lêernaam wat u verskaf en ander inligting. Die hoofprojeklêer bevat inligting oor die ander lêers, wat 'n inhoudslêer, 'n indekslêer, een of meer beeldlêers en ander lêers insluit.
- Die inhoudslêer bevat die teks in die hulplêer wat verduidelik hoe die sagtewaretoepassing wat u dokumenteer werk. Die teks word gewoonlik verdeel in onderwerpe wat 'n spesifieke skerm, funksie of prosedure dek.
- Die indekslêer is 'n lys van die onderwerpe van die hulplêer. Dit word gebruik om 'n inhoudsopgawe te skep wat gebruikers kan gebruik om 'n onderwerp te kies, sowel as 'n soekbare indeks in die hulplêer.
- Beeldlêers is grafiese lêers van programskerms of gedeeltes van die skerms wat in die hulplêer vertoon word, om die gebruikers se vermoë om te verstaan waarna die teks in die hulplêer verwys, te verbeter.
Stap 4. Pas die grootte van die hulpvenster aan
Tensy u die hulplêer skryf om in die gebruiker se webblaaier te verskyn, verskyn die hulplêer in sy eie venster. Met u hulpskrywingsinstrument kan u die venster se horisontale en vertikale afmetings aanpas tot 'n grootte waarmee die eindgebruiker die hulplêer kan lees sonder dat dit die program self belemmer. Die hoofhulpvenster is dikwels in 'n drie-paneel-formaat, met die inhoudsopgawe aan die linkerkant en die geselekteerde onderwerp aan die regterkant.
Benewens die hoofvenster kan hulplêers ook sekondêre vensters bevat wat 'n spesifieke funksie in detail beskryf en outomaties die grootte van opspringvensters met 'n kort beskrywing van funksies. Hulplêers kan ook ingeslote teks insluit wat slegs verskyn as gemerkte teks of 'n knoppie geklik word
Stap 5. Skryf die hulponderwerpe neer
Om dit te kan doen, moet u die spesifikasies of die program self hersien om die onderwerpe te skep om die skerms en funksies van die program te dokumenteer. Terwyl u elke onderwerp skep, sal u hulpvervaardigingsinstrument dit by die inhoudsopgawe en indeks van die hulplêer voeg.
- Alhoewel u die inhoudsopgawe soos u kan bou, help dit om 'n plan te hê oor hoe u dit kan organiseer. U kan die inhoudsopgawe rangskik rondom die skerms van die program, die funksies daarvan, maniere om dit te gebruik of 'n kombinasie daarvan.
- Terwyl u die onderwerpe skryf, moet u ander inligting in die hulplêer oorweeg wat gebruikers vinnig toegang tot wil hê. U kan spronge of hiperskakels skep in die teks van die hulplêer wat aansluit by die onderwerpe wat die inligting bevat.
Stap 6. Sluit skermkiekies in, indien nodig
Baie programkenmerke word die beste verduidelik met 'n kombinasie van teks en grafika. U kan skermkiekies maak met die toepassing wat by u hulpverleningshulpmiddel kom, of met 'n aparte toepassing, soos Microsoft Paint, Paint Shop Pro of SnagIt.
- Teks en skermkiekies moet saam uiteengesit word in 'n onderwerp sodat gebruikers die skermkiekie en die ondersteunende teks daarvan kan sien sonder om te veel te blaai. In baie gevalle wil u 'n gedeelte van 'n programskerm in plaas van die hele skerm wys, of die skermkiekie in 'n kleiner grootte as die oorspronklike wys. U skermkiekie -toepassing moet die grootte van die skermkiekie kan verander sonder om dit te vervaag of detail te verloor.
- As u veranderinge aan die gebruikerskoppelvlak tussen die toets en die finale weergawes van die program verwag, wil u moontlik nie langer skermkiekies maak totdat u die finale weergawe van die program kan aanpak nie.
Stap 7. Skep 'n kaartlêer indien nodig
Sommige programme bevat 'Help' -knoppies waarmee 'n gebruiker kan klik en die onderwerp kan vertoon in die hulplêer wat spesifiek beskryf hoe die skerm werk. Om 'n onderwerp op hierdie manier te vertoon, word konteks-sensitiewe hulp genoem en vereis dat 'n kaartlêer vir die programmeerder geskep word om die "Help" -knoppie aan die spesifieke onderwerp in u hulplêer te koppel. Jou hulpvervaardigingshulpmiddel kan een vir jou skep, of die programmeerder kan dit kodeer en dit vir jou gee om in die hulplêer op te neem.
Stap 8. Stel die hulplêer saam
Opstel skep die werklike hulplêer wat by die program ingesluit sal word. Vir die meeste hulpformate bevat dit alle komponentlêers wat geskep is toe u die hulplêer geskep het, hoewel sommige nie -saamgestelde hulpformate ook vereis dat die individuele hulponderwerplêers by die program ingesluit moet word.
Stap 9. Toets die hulplêer
Sodra u die hulplêer saamgestel het, moet u dit toets om seker te maak dat al die hiperskakels aansluit by die onderwerpe waarna hulle veronderstel is en dat alle grafika korrek vertoon word. Die hulplêer moet ook getoets word om te verseker dat die inhoud akkuraat en geskik is vir die gebruikers en in 'n konsekwente formaat. U wil self die hulplêer hersien en die mense wat die program toets, dit ook hersien.
By groter hulplêerprojekte is opstel en toetsing voortgesette prosesse. U wil die hulplêer saamstel en u werk verskeie kere kontroleer voordat u die finale weergawe skep
Stap 10. Gee die hulplêer aan die ontwikkelaar wat by die program ingesluit moet word
Afhangende van die aard van die projek en die lêerformaat van die projek, moet u moontlik verskeie lêers aan die ontwikkelaar verskaf, insluitend 'n kaartlêer as daar konteksgevoelige onderwerpe is.
