Een helpbestand maken: 10 stappen (met afbeeldingen)

Inhoudsopgave:

Een helpbestand maken: 10 stappen (met afbeeldingen)
Een helpbestand maken: 10 stappen (met afbeeldingen)

Video: Een helpbestand maken: 10 stappen (met afbeeldingen)

Video: Een helpbestand maken: 10 stappen (met afbeeldingen)
Video: how to edit scanned pdf document, easy and fastest way to edit scanned document online free 2024, Maart
Anonim

Hoewel vaak genegeerd door veel computergebruikers, bieden Help-bestanden belangrijke informatie over het gebruik van de softwaretoepassing waaraan ze zijn gekoppeld. Door op "Help" te klikken, kan een gebruiker een overzicht krijgen van de functies van het programma, een beschrijving van het scherm waarnaar hij of zij kijkt, instructies over hoe het programma te gebruiken om een bepaalde taak uit te voeren of lijsten met veelgestelde vragen over de programma en hun antwoorden. Het schrijven van een helpbestand vereist zowel het vermogen om met softwaretoepassingen te werken als het vermogen om dingen uit te leggen op een manier die gebruikers kunnen begrijpen.

Stappen

Maak een Help-bestand Stap 1
Maak een Help-bestand Stap 1

Stap 1. Verkrijg een kopie van de software die u wilt documenteren

Indien mogelijk moet u ook een kopie krijgen van de schriftelijke specificaties voor het programma, hoewel niet alle softwareontwikkelaars ermee werken. In sommige gevallen zal de programmeur afwijken van de specificaties, op basis van korte ontwikkeltijd of het niet kunnen coderen van een bepaalde feature.

Maak een Help-bestand Stap 2
Maak een Help-bestand Stap 2

Stap 2. Verkrijg een hulpmiddel voor het maken van hulp

Hoewel het mogelijk is om met de hand een helpbestand te maken met behulp van een rich-text-formaat (.rtf)-bestand, gebruiken de meeste auteurs van helpbestanden een softwaretoepassing om hun helpbestanden te schrijven, zoals RoboHelp, Help en handleiding, Doc-To -Help, MadCap Flare of HelpLogix. De meeste hulpprogramma's voor het schrijven van hulp bevatten een teksteditor of werken met een tekstverwerkingsprogramma zoals Microsoft Word en bieden een gebruikersinterface waarmee de auteur van de hulp kan zien hoe het helpbestand eruit zal zien terwijl hij of zij het schrijft terwijl hij achter de schermen computercode schrijft om het helpbestand te laten werken. Sommige hulpprogramma's voor het maken van hulp bevatten ook grafische editors voor het maken van schermafbeeldingen om op te nemen in het helpbestand.

Er zijn een aantal helpbestandsindelingen: De meest voorkomende is HTML Help, die wordt gebruikt door toepassingen die onder Windows draaien. (Een ouder formaat, WinHelp, wordt niet langer ondersteund.) Apple en Unix hebben elk hun eigen formaten, evenals Sun Microsystems, met zijn JavaHelp. Softwaretoepassingen die zijn ontworpen om onder verschillende besturingssystemen te draaien, kunnen een platformonafhankelijk helpsysteem gebruiken dat in de webbrowser van de gebruiker wordt uitgevoerd. Welk hulpmiddel voor het maken van hulp u ook gebruikt, het moet de hulpindeling(en) ondersteunen waarin u hulpbestanden gaat maken

Maak een Help-bestand Stap 3
Maak een Help-bestand Stap 3

Stap 3. Maak het helpprojectbestand aan

Uw hulpmiddel voor het maken van hulp zal een hulpprojectbestand voor u maken op basis van de bestandsnaam die u opgeeft en andere informatie. Het hoofdprojectbestand bevat informatie over de andere bestanden, waaronder een inhoudsbestand, een indexbestand, een of meer afbeeldingsbestanden en andere bestanden.

  • Het inhoudsbestand bevat de tekst in het helpbestand waarin wordt uitgelegd hoe de softwaretoepassing die u documenteert, werkt. De tekst is meestal onderverdeeld in onderwerpen die betrekking hebben op een specifiek scherm, functie of procedure.
  • Het indexbestand is een lijst met de onderwerpen van het helpbestand. Het wordt gebruikt om een inhoudsopgave te maken die gebruikers kunnen gebruiken om een onderwerp te selecteren om te bekijken, evenals een doorzoekbare index in het helpbestand.
  • Afbeeldingsbestanden zijn grafische bestanden van programmaschermen of gedeelten van die schermen die in het helpbestand worden weergegeven om de gebruikers beter in staat te stellen te begrijpen waarnaar de tekst van het helpbestand verwijst.
Maak een Help-bestand Stap 4
Maak een Help-bestand Stap 4

Stap 4. Pas de grootte van het helpvenster aan

Tenzij u het Help-bestand schrijft om in de webbrowser van de gebruiker te verschijnen, zal het Help-bestand in een eigen venster verschijnen. Met uw hulpmiddel voor het maken van hulp kunt u de horizontale en verticale afmetingen van het venster aanpassen aan een grootte die de eindgebruiker in staat stelt het helpbestand te lezen zonder de toepassing zelf in de weg te staan. Het hoofdhelpvenster is vaak in drieën gedeeld, met de inhoudsopgave aan de linkerkant en het geselecteerde onderwerp aan de rechterkant.

Help-bestanden kunnen, naast het hoofdvenster, ook secundaire vensters hebben die een bepaalde functie in detail beschrijven en pop-upvensters met automatische grootte die korte beschrijvingen van functies geven. Help-bestanden kunnen ook ingesloten tekst bevatten die alleen verschijnt wanneer gemarkeerde tekst of een knop wordt aangeklikt

Maak een Help-bestand Stap 5
Maak een Help-bestand Stap 5

Stap 5. Schrijf de helponderwerpen

Om dit te doen, moet u de specificaties of het programma zelf bekijken om de onderwerpen te maken om de schermen en functies van het programma te documenteren. Terwijl u elk onderwerp maakt, voegt uw hulpmiddel voor het maken van hulp het toe aan de inhoudsopgave en index van het hulpbestand.

  • Hoewel u de inhoudsopgave gaandeweg kunt samenstellen, helpt het om een plan te hebben voor het organiseren ervan. U kunt de inhoudsopgave ordenen rond de schermen van het programma, de functies, manieren om het te gebruiken of een combinatie daarvan.
  • Houd bij het schrijven van de onderwerpen rekening met andere informatie in het Help-bestand waartoe gebruikers snel toegang willen hebben. U kunt sprongen of hyperlinks maken in de tekst van het helpbestand die verbinding maken met de onderwerpen die die informatie bevatten.
Maak een Help-bestand Stap 6
Maak een Help-bestand Stap 6

Stap 6. Voeg indien nodig screenshots toe

Veel programmafuncties kunnen het beste worden uitgelegd met een combinatie van tekst en afbeeldingen. U kunt schermafbeeldingen maken met de toepassing die bij uw hulpmiddel voor het maken van hulp wordt geleverd of met een afzonderlijke toepassing, zoals Microsoft Paint, Paint Shop Pro of SnagIt.

  • Tekst en schermafbeeldingen moeten samen in een onderwerp worden geplaatst, zodat gebruikers de schermafbeelding en de bijbehorende tekst kunnen zien zonder onnodig te hoeven scrollen. In veel gevallen wil je een deel van een programmascherm weergeven in plaats van het hele scherm, of de schermafbeelding in een kleiner formaat dan het origineel. Uw screenshot-applicatie moet in staat zijn om het formaat van de screenshot te wijzigen zonder vervaging of verlies van detail.
  • Als u wijzigingen verwacht in de gebruikersinterface tussen de test- en definitieve versies van het programma, kunt u het maken van schermafbeeldingen uitstellen totdat u de definitieve versie van het programma hebt om mee te werken.
Maak een Help-bestand Stap 7
Maak een Help-bestand Stap 7

Stap 7. Maak een kaartbestand, indien nodig

Sommige programma's bevatten "Help"-knoppen waarop een gebruiker kan klikken en het onderwerp in het helpbestand kan weergeven dat specifiek beschrijft hoe dat scherm werkt. Het op deze manier weergeven van een onderwerp wordt contextgevoelige hulp genoemd en vereist het maken van een kaartbestand voor de programmeur om de "Help"-knop te koppelen aan het specifieke onderwerp in uw helpbestand. Uw hulpmiddel voor het maken van hulp kan er een voor u maken, of de programmeur kan het coderen en aan u geven om in het helpbestand op te nemen.

Maak een Help-bestand Stap 8
Maak een Help-bestand Stap 8

Stap 8. Compileer het helpbestand

Compileren creëert het eigenlijke helpbestand dat bij het programma wordt gevoegd. Voor de meeste helpformaten zal dit alle componentbestanden bevatten die zijn gemaakt toen u het helpbestand maakte, hoewel sommige niet-gecompileerde helpformaten ook vereisen dat de individuele help-onderwerpbestanden bij het programma worden gevoegd.

Maak een Help-bestand Stap 9
Maak een Help-bestand Stap 9

Stap 9. Test het helpbestand

Nadat u het helpbestand hebt gecompileerd, moet u het testen om er zeker van te zijn dat alle hyperlinks verbinding maken met de onderwerpen die ze zouden moeten behandelen en dat alle afbeeldingen correct worden weergegeven. Het helpbestand moet ook worden getest om ervoor te zorgen dat de inhoud nauwkeurig en geschikt is voor de gebruikers en in een consistent formaat. U wilt het Help-bestand zelf bekijken en de mensen die de toepassing testen, het ook laten beoordelen.

Bij grotere projecten met helpbestanden zijn het compileren en testen een doorlopend proces. U wilt het helpbestand compileren en uw werk meerdere keren controleren voordat u de definitieve versie maakt

Maak een Help-bestand Stap 10
Maak een Help-bestand Stap 10

Stap 10. Geef het helpbestand aan de ontwikkelaar om bij het programma te voegen

Afhankelijk van de aard van het project en de bestandsindeling van de help, moet u de ontwikkelaar mogelijk meerdere bestanden verstrekken, inclusief een kaartbestand als er contextgevoelige onderwerpen zijn.

Aanbevolen: