Selv om mange databrukere ofte ignorerer dem, gir hjelpefiler viktig informasjon om hvordan de bruker programvaren de er tilknyttet. Ved å klikke "Hjelp" kan en bruker få en oversikt over programmets funksjoner, en beskrivelse av skjermen han eller hun ser på, instruksjoner om hvordan du bruker programmet til å utføre en gitt oppgave eller lese lister over vanlige spørsmål om programmet og svarene deres. Å skrive en hjelpefil krever både evnen til å jobbe med programmer og evnen til å forklare ting på en måte som brukerne kan forstå.
Trinn
Trinn 1. Få en kopi av programvaren du skal dokumentere
Hvis mulig, bør du også få en kopi av de skriftlige spesifikasjonene for programmet, selv om ikke alle programvareutviklere jobber med dem. I noen tilfeller vil programmereren avvike fra spesifikasjonene, basert på kort utviklingstid eller ikke kunne kode en bestemt funksjon.
Trinn 2. Skaff deg et hjelpeforfatterverktøy
Selv om det er mulig å lage en hjelpefil for hånd, ved hjelp av en rik-tekst-format (.rtf) -fil, bruker de fleste hjelpefilforfattere et program for å skrive hjelpefiler, for eksempel RoboHelp, Help and Manual, Doc-To -Hjelp, MadCap Flare eller HelpLogix. De fleste hjelpeverktøyene inkluderer en tekstredigerer eller arbeid med et tekstbehandlingsprogram som Microsoft Word og gir et brukergrensesnitt som lar hjelpeforfatteren se hvordan hjelpefilen vil se ut mens han eller hun skriver den mens han skriver datakode bak kulissene for å få hjelpefilen til å fungere. Noen redigeringsverktøy for hjelp inkluderer også grafikkredaktører for å lage skjermbilder som skal inkluderes i hjelpefilen.
Det finnes en rekke hjelpefilformater: Det vanligste er HTML Help, som brukes av programmer som kjører i Windows. (Et eldre format, WinHelp, støttes ikke lenger.) Apple og Unix har også sine egne formater, i likhet med Sun Microsystems, med JavaHelp. Programvare som er designet for å kjøre under flere operativsystemer, kan bruke et hjelpesystem på tvers av plattformer som kjøres i brukerens nettleser. Uansett hvilket redigeringsverktøy du bruker, bør du støtte støtteformatene du vil lage hjelpefiler i
Trinn 3. Lag hjelpeprosjektfilen
Hjelpeforfatterverktøyet ditt vil lage en hjelpeprosjektfil for deg, basert på filnavnet du oppgir og annen informasjon. Hovedprosjektfilen inneholder informasjon om de andre filene, som inkluderer en innholdsfil, en indeksfil, en eller flere bildefiler og andre filer.
- Innholdsfilen inneholder teksten i hjelpefilen som forklarer hvordan programmet du dokumenterer fungerer. Teksten er vanligvis delt inn i emner som dekker en bestemt skjerm, funksjon eller prosedyre.
- Indeksfilen er en liste over hjelpefilens emner. Den brukes til å lage en innholdsfortegnelse som brukerne kan bruke til å velge et emne å se, samt en søkbar indeks i hjelpefilen.
- Bildefiler er grafiske filer med programskjermbilder eller deler av skjermbildene som vises i hjelpefilen for å forbedre brukernes evne til å forstå hva hjelpefilteksten refererer til.
Trinn 4. Juster størrelsen på hjelpevinduet
Med mindre du skriver hjelpefilen for å vises i brukerens nettleser, vil hjelpefilen vises i sitt eget vindu. Hjelpeforfatterverktøyet lar deg justere vinduets horisontale og vertikale dimensjoner til en størrelse som lar sluttbrukeren lese hjelpefilen uten at det kommer i veien for selve applikasjonen. Hovedhjelpsvinduet er ofte i et tre-rutes format, med innholdsfortegnelsen til venstre og det valgte emnet til høyre.
Hjelpfiler kan også ha, i tillegg til hovedvinduet, sekundære vinduer som beskriver en bestemt funksjon i detalj og automatisk størrelsen på popup-vinduer som gir korte beskrivelser av funksjoner. Hjelpefiler kan også inneholde innebygd tekst som bare vises når uthevet tekst eller en knapp klikkes
Trinn 5. Skriv hjelpemnene
For å gjøre dette må du gå gjennom spesifikasjonene eller selve programmet for å lage emner for å dokumentere programmets skjermer og funksjoner. Når du oppretter hvert emne, vil hjelpeforfatterverktøyet legge det til i hjelpefilens innholdsfortegnelse og indeks.
- Selv om du kan bygge innholdsfortegnelsen mens du går, hjelper det å ha en plan for hvordan du organiserer den. Du kan organisere innholdsfortegnelsen rundt programmets skjermer, funksjonene, måtene å bruke den eller en kombinasjon derav.
- Når du skriver emnene, bør du vurdere annen informasjon i hjelpefilen som brukerne vil ha rask tilgang til. Du kan lage hopp eller hyperkoblinger i hjelpefilteksten som kobler seg til emnene som har denne informasjonen.
Trinn 6. Inkluder skjermbilder om nødvendig
Mange programfunksjoner forklares best med en kombinasjon av tekst og grafikk. Du kan lage skjermbilder enten med programmet som følger med redigeringsverktøyet for hjelpen eller med et eget program, for eksempel Microsoft Paint, Paint Shop Pro eller SnagIt.
- Tekst og skjermbilder bør legges sammen i et emne slik at brukerne kan se skjermdumpen og den støttende teksten uten unødig rulling. I mange tilfeller vil du vise en del av en programskjerm i stedet for hele skjermen, eller vise skjermbildet i en mindre størrelse enn originalen. Skjermdump -applikasjonen din skal kunne endre størrelsen på skjermbildet uten å bli uskarp eller miste detaljer.
- Hvis du forventer endringer i brukergrensesnittet mellom testen og den siste versjonen av programmet, kan det være lurt å holde på med å lage skjermbilder til du har den endelige versjonen av programmet å jobbe med.
Trinn 7. Lag en kartfil hvis det er nødvendig
Noen programmer inkluderer "Hjelp" -knapper for en bruker å klikke og vise emnet i hjelpefilen som spesifikt beskriver hvordan skjermen fungerer. Å vise et emne på denne måten kalles kontekstsensitiv hjelp og krever at du oppretter en kartfil for programmereren for å koble "Hjelp" -knappen til det spesifikke emnet i hjelpefilen. Hjelpeforfatterverktøyet kan lage et for deg, eller programmereren kan kode det og gi det til å inkludere det i hjelpefilen.
Trinn 8. Kompiler hjelpefilen
Kompilering oppretter den faktiske hjelpefilen som skal inkluderes i programmet. For de fleste hjelpeformater vil dette inneholde alle komponentfilene som ble opprettet da du opprettet hjelpefilen, selv om noen ukompilerte hjelpeformater også krever at de enkelte hjelpemne -filene skal inkluderes i programmet.
Trinn 9. Test hjelpefilen
Når du har samlet hjelpefilen, må du teste den for å sikre at alle hyperkoblinger kobles til emnene de skal, og at all grafikk vises korrekt. Hjelpefilen må også testes for å sikre at innholdet er nøyaktig og passende for brukerne og i et konsistent format. Du vil selv gå gjennom hjelpefilen og få folk som tester programmet til å vurdere den.
På større hjelpefilprosjekter er kompilering og testing pågående prosesser. Du vil kompilere hjelpefilen og sjekke arbeidet ditt flere ganger før du lager den endelige versjonen
Trinn 10. Gi hjelpefilen til utvikleren som skal inkluderes i programmet
Avhengig av prosjektets art og hjelpefilformat, må du kanskje gi utvikleren flere filer, inkludert en kartfil hvis det er kontekstsensitive temaer.
