Hoe om `n hulp lêer te skep

Alhoewel hulle dikwels deur rekenaargebruikers geïgnoreer word, verskaf die help lêers belangrike inligting oor die gebruik van die programmatuurprogram waarmee hulle geassosieer word. Deur op "Help" te klik, kan `n gebruiker `n oorsig kry oor die funksies van die program, `n beskrywing van die skerm waarna hulle kyk, instruksies oor hoe om die program te gebruik om sekere take uit te voer of lyste van algemene vrae oor die program te lees. program en sy antwoorde. Om `n hulp lêer te skryf, vereis beide die vermoë om met sagteware programme te werk, asook die vermoë om dinge te verduidelik op `n manier wat gebruikers kan verstaan. Hieronder is `n gids vir die maak van `n hulp lêer.

conținut

Stappe
Wenke
Dinge wat jy nodig het

stappe

Kry `n kopie van die sagteware wat jy gaan dokumenteer. Indien moontlik, moet u ook `n afskrif van die skriftelike spesifikasies van die program kry, hoewel nie alle sagteware-ontwikkelaars saam met hulle werk nie. In sommige gevalle verskil die programmeerder van die spesifikasies, gebaseer op hoe min tyd hy moet ontwikkel of omdat hy nie in staat is om `n spesifieke kenmerk te koder nie.

Kry `n outeur-hulpmiddel vir hulp. As dit moontlik is om `n helplêer met die hand te skep, met `n ryk teksformatering (.rtf), gebruik die meeste hulp lêer outeurs `n sagtewareprogram om die hulplêers te skryf, soos RoboHelp, Help and Manual , Doc-To-Help, MadCap Flare of HelpLogix. Die meeste gereedskap vir die outeur van hulp sluit in `n teksredakteur of werk met `n woordverwerkerprogram soos Microsoft Word en bied `n koppelvlak aan die gebruiker wat die skrywer laat sien hoe die hulp lêer sal lyk. Sommige hulpmiddels vir die skrywer van hulp sluit ook grafiese redakteurs in om skermkiekies te skep en hulle in die hulp lêer in te sluit.

Skep die hulpprojek lêer. Jou hulpmiddel vir hulp outeurs sal die hulpprojek lêer vir jou opstel, gebaseer op die naam van die lêer wat jy verskaf en ander inligting. Die hooflêer van die hulpprojek bevat inligting oor ander lêers, insluitend `n inhoudslêer, `n indeks, een of meer beeldlêers en ander lêers.

Pas die grootte van die hulpvenster aan. Tensy u die hulp lêer skryf om in die gebruiker se webblaaier te verskyn, sal die hulp lêer in u eie venster verskyn. Jou hulpmiddel sal jou toelaat om die vertikale en horisontale afmetings van die venster aan te pas tot `n sekere grootte wat die gebruiker toelaat om die helplêer te lees sonder om in die pad van die aansoek self te kom.

Skryf die hulponderwerpe. Om dit te doen moet u die spesifikasies en die program self hersien. Soos u elke onderwerp maak, sal u hulpmiddel dit by die hulp lêer in die inhoud en indeksdeel voeg.

Sluit skermkiekies in indien nodig. Baie van die funksies van `n sekere program word die beste verduidelik met `n kombinasie van grafika en teks. U kan skermkiekies maak met óf die program wat met u hulpprogramma of met `n aparte aansoek kom.

Skep `n kaartlêer indien nodig. Sommige programme sluit in "Help" knoppies sodat wanneer die gebruiker kliek, die onderwerp in die hulp lêer vertoon word en spesifiek beskryf hoe die skerm werk.

Stel die hulp lêer saam. By die samestelling word die hulp lêer wat in die program ingesluit word, geskep.

Probeer die hulp lêer. Sodra die lêer saamgestel is, is dit nodig om seker te maak of alles korrek werk.

Gee die ontwikkelaar se hulplêer om dit in die program in te sluit.

wenke

In maatskappye met groot tegniese afdelings kan baie skrywers van hulplêers toegewys word aan `n projek, sommige met onderwerpe in spesifieke areas, ander wat skermkiekies skep en `n direkteur wat die werk gereeld hersien. Kleiner maatskappye huur waarskynlik `n enkele skrywer van hulplêers.

Dinge wat jy nodig het

Sagteware help lêer
Sagteware skermkiekie redakteur

Deel op sosiale netwerke:

Verwante