Selvom det ofte ignoreres af mange computerbrugere, hjælper hjælpefiler med vigtige oplysninger om, hvordan de bruger den softwareprogram, de er tilknyttet. Ved at klikke på "Hjælp" kan en bruger få et overblik over programmets funktioner, en beskrivelse af den skærm, han eller hun ser på, instruktioner om, hvordan man bruger programmet til at udføre en given opgave eller læse lister over ofte stillede spørgsmål om program og deres svar. At skrive en hjælpefil kræver både evnen til at arbejde med softwareapplikationer og evnen til at forklare tingene på en måde, som brugerne kan forstå.
Trin
Trin 1. Få en kopi af den software, du skal dokumentere
Hvis det er muligt, bør du også få en kopi af de skriftlige specifikationer for programmet, selvom ikke alle softwareudviklere arbejder med dem. I nogle tilfælde vil programmereren afvige fra specifikationerne, baseret på kort udviklingstid eller ikke være i stand til at kode en bestemt funktion.
Trin 2. Få et redigeringsværktøj til hjælp
Selvom det er muligt at oprette en hjælpefil manuelt ved hjælp af en rich-text-format (.rtf) -fil, bruger de fleste hjælpefilforfattere et softwareprogram til at skrive deres hjælpefiler, f.eks. RoboHelp, Help and Manual, Doc-To -Hjælp, MadCap Flare eller HelpLogix. De fleste redigeringsværktøjer til hjælp inkluderer en tekstredigerer eller arbejde med et tekstbehandlingsprogram som Microsoft Word og giver en brugergrænseflade, der lader hjælpeforfatteren se, hvordan hjælpefilen vil se ud, mens han eller hun skriver den, mens han skriver computerkode bag kulisserne at få hjælpefilen til at fungere. Nogle redigeringsværktøjer til hjælp indeholder også grafiske redaktører til oprettelse af skærmbilleder, der skal medtages i hjælpefilen.
Der er en række hjælpefilformater: Den mest almindelige er HTML -hjælp, som bruges af programmer, der kører i Windows. (Et ældre format, WinHelp, understøttes ikke længere.) Apple og Unix har også deres egne formater, ligesom Sun Microsystems har JavaHelp. Softwareapplikationer, der er designet til at køre under flere operativsystemer, kan bruge et cross-platform-hjælpesystem, der kører i brugerens webbrowser. Uanset hvilket redigeringsværktøj, du bruger, skal understøtte det eller de hjælpeformater, du vil oprette hjælpefiler i
Trin 3. Opret hjælpeprojektfilen
Dit redigeringsværktøj til hjælp opretter en hjælpeprojektfil til dig, baseret på det filnavn, du angiver, og andre oplysninger. Hovedprojektfilen indeholder oplysninger om de andre filer, som omfatter en indholdsfil, en indeksfil, en eller flere billedfiler og andre filer.
- Indholdsfilen indeholder teksten i hjælpefilen, der forklarer, hvordan det softwareprogram, du dokumenterer, fungerer. Teksten er normalt opdelt i emner, der dækker en bestemt skærm, funktion eller procedure.
- Indeksfilen er en liste over hjælpefilens emner. Det bruges til at oprette en indholdsfortegnelse, som brugerne kan bruge til at vælge et emne, der skal vises, samt et søgbart indeks i hjælpefilen.
- Billedfiler er grafiske filer med programskærme eller dele af disse skærme, der vises i hjælpefilen for at forbedre brugernes evne til at forstå, hvad hjælpefilsteksten henviser til.
Trin 4. Juster størrelsen på hjælpevinduet
Medmindre du skriver hjælpefilen til at blive vist i brugerens webbrowser, vises hjælpefilen i sit eget vindue. Dit redigeringsværktøj hjælper dig med at justere vinduets vandrette og lodrette dimensioner til en størrelse, der gør det muligt for slutbrugeren at læse hjælpefilen, uden at det kommer i vejen for selve applikationen. Hovedhjælp vinduet er ofte i et tre-rude format, med indholdsfortegnelsen til venstre og det valgte emne til højre.
Hjælpfiler kan ud over hovedvinduet også have sekundære vinduer, der beskriver en bestemt funktion i detaljer og automatisk størrelse på pop op-vinduer, der giver korte beskrivelser af funktioner. Hjælpfiler kan også indeholde integreret tekst, der kun vises, når der fremhæves tekst eller en knap
Trin 5. Skriv hjælpemnerne
For at gøre dette skal du gennemgå specifikationerne eller selve programmet for at oprette emnerne til dokumentation af programmets skærme og funktioner. Når du opretter hvert emne, føjer dit hjælpeforfatterværktøj det til hjælpefilens indholdsfortegnelse og indeks.
- Selvom du kan bygge indholdsfortegnelsen undervejs, hjælper det at have en plan for, hvordan den skal organiseres. Du kan organisere indholdsfortegnelsen omkring programmets skærme, dets funktioner, måder at bruge den eller en kombination heraf.
- Når du skriver emnerne, skal du overveje andre oplysninger i hjælpefilen, som brugerne vil have hurtig adgang til. Du kan oprette spring eller hyperlinks i hjælpefilsteksten, der forbinder til emnerne, der har disse oplysninger.
Trin 6. Inkluder om nødvendigt skærmbilleder
Mange programfunktioner forklares bedst med en kombination af tekst og grafik. Du kan oprette skærmbilleder med enten det program, der følger med dit redigeringsværktøj til hjælp eller med et separat program, f.eks. Microsoft Paint, Paint Shop Pro eller SnagIt.
- Tekst og skærmbilleder skal lægges sammen i et emne, så brugerne kan se skærmbilledet og dets understøttende tekst uden unødig rulning. I mange tilfælde vil du gerne vise en del af en programskærm i stedet for hele skærmen eller vise skærmbilledet i en mindre størrelse end originalen. Din skærmbillede -applikation skal kunne ændre størrelsen på skærmbilledet uden at sløre eller tabe detaljer.
- Hvis du forventer ændringer af brugergrænsefladen mellem testen og den endelige version af programmet, kan du holde ud med at oprette skærmbilleder, indtil du har den sidste version af programmet at arbejde med.
Trin 7. Opret en kortfil, hvis det er nødvendigt
Nogle programmer indeholder "Hjælp" -knapper, som en bruger kan klikke på og vise emnet i hjælpefilen, der specifikt beskriver, hvordan denne skærm fungerer. Visning af et emne på denne måde kaldes kontekstfølsom hjælp og kræver, at der oprettes en kortfil for programmereren til at linke "Hjælp" -knappen til det specifikke emne i din hjælpefil. Dit redigeringsværktøj til hjælp kan oprette et til dig, eller programmøren kan kode det og give det til dig at inkludere i hjælpefilen.
Trin 8. Kompilér hjælpefilen
Kompilering opretter den faktiske hjælpefil, der vil blive inkluderet i programmet. For de fleste hjælpeformater vil dette inkorporere alle de komponentfiler, der blev oprettet, da du oprettede hjælpefilen, selvom nogle ikke -kompilerede hjælpeformater også kræver, at de enkelte hjælpemne -filer skal inkluderes i programmet.
Trin 9. Test hjælpefilen
Når du har kompileret hjælpefilen, skal du teste den for at sikre, at alle hyperlinks forbinder til de emner, de skal, og al grafik vises korrekt. Hjælpefilen skal også testes for at sikre, at indholdet er korrekt og passende for brugerne og i et konsistent format. Du vil gerne selv gennemgå hjælpefilen og få folk til at teste applikationen til at gennemgå den.
På større hjælpefilprojekter er kompilering og test løbende processer. Du vil kompilere hjælpefilen og kontrollere dit arbejde flere gange, før du opretter den endelige version
Trin 10. Giv hjælpefilen til udvikleren, der skal medtages i programmet
Afhængigt af projektets art og hjælpefilformat skal du muligvis give udvikleren flere filer, herunder en kortfil, hvis der er kontekstfølsomme emner.
