Även om de ofta ignoreras av många datoranvändare, ger hjälpfilerna viktig information om hur de använder de program som de är associerade med. Genom att klicka på "Hjälp" kan en användare få en översikt över programmets funktioner, en beskrivning av skärmen han eller hon tittar på, instruktioner om hur man använder programmet för att utföra en given uppgift eller läsa listor med vanliga frågor om programmet och deras svar. Att skriva en hjälpfil kräver både förmågan att arbeta med program och förmågan att förklara saker på ett sätt som användarna kan förstå.
Steg
Steg 1. Skaffa en kopia av den programvara du ska dokumentera
Om möjligt bör du också få en kopia av de skriftliga specifikationerna för programmet, även om inte alla programutvecklare arbetar med dem. I vissa fall kommer programmeraren att avvika från specifikationerna, baserat på kort utvecklingstid eller inte kunna koda en viss funktion.
Steg 2. Skaffa ett hjälpredigeringsverktyg
Även om det är möjligt att skapa en hjälpfil för hand, med hjälp av en rich-text-format (.rtf) -fil, använder de flesta hjälpfilförfattare ett program för att skriva sina hjälpfiler, till exempel RoboHelp, Help and Manual, Doc-To -Hjälp, MadCap Flare eller HelpLogix. De flesta hjälpredigeringsverktygen inkluderar en textredigerare eller arbeta med ett ordbehandlingsprogram som Microsoft Word och ger ett användargränssnitt som låter hjälpförfattaren se hur hjälpfilen kommer att se ut när han eller hon skriver den medan han skriver datorkod bakom kulisserna för att få hjälpfilen att fungera. Vissa hjälpredigeringsverktyg inkluderar också grafiska redaktörer för att skapa skärmdumpar som ska inkluderas i hjälpfilen.
Det finns ett antal hjälpfilformat: Det vanligaste är HTML -hjälp, som används av program som körs i Windows. (Ett äldre format, WinHelp, stöds inte längre.) Apple och Unix har alla sina egna format, liksom Sun Microsystems, med sin JavaHelp. Program som är utformade för att köras under flera operativsystem kan använda ett plattformshjälpsystem som körs i användarens webbläsare. Oavsett vilket hjälpredigeringsverktyg du använder bör stödja hjälpformaten som du ska skapa hjälpfiler i
Steg 3. Skapa hjälpprojektfilen
Ditt hjälpredigeringsverktyg skapar en hjälpprojektfil åt dig, baserat på filnamnet du tillhandahåller och annan information. Huvudprojektfilen innehåller information om de andra filerna, som innehåller en innehållsfil, en indexfil, en eller flera bildfiler och andra filer.
- Innehållsfilen innehåller texten i hjälpfilen som förklarar hur det program du dokumenterar fungerar. Texten är vanligtvis uppdelad i ämnen som täcker en specifik skärm, funktion eller procedur.
- Indexfilen är en lista över hjälpfilens ämnen. Den används för att skapa en innehållsförteckning som användare kan använda för att välja ett ämne att visa, samt ett sökbart index i hjälpfilen.
- Bildfiler är grafiska filer med programskärmar eller delar av de skärmar som visas i hjälpfilen för att förbättra användarnas förmåga att förstå vad hjälpfilstexten syftar på.
Steg 4. Justera storleken på hjälpfönstret
Om du inte skriver hjälpfilen för att visas i användarens webbläsare visas hjälpfilen i ett eget fönster. Ditt hjälpredigeringsverktyg låter dig justera fönstrets horisontella och vertikala dimensioner till en storlek som låter slutanvändaren läsa hjälpfilen utan att det kommer i vägen för själva applikationen. Huvudhjälpfönstret är ofta i ett trefältformat, med innehållsförteckningen till vänster och det valda ämnet till höger.
Hjälpfiler kan förutom huvudfönstret också ha sekundära fönster som beskriver en viss funktion i detalj och automatiskt dimensionera popup-fönster som ger korta beskrivningar av funktioner. Hjälpfiler kan också innehålla inbäddad text som bara visas när markerad text eller en knapp klickas
Steg 5. Skriv hjälpämnena
För att göra detta måste du granska specifikationerna eller själva programmet för att skapa ämnen för att dokumentera programmets skärmar och funktioner. När du skapar varje ämne kommer ditt hjälpredigeringsverktyg att lägga till det i hjälpfilens innehållsförteckning och index.
- Medan du kan bygga innehållsförteckningen under tiden, hjälper det att ha en plan för hur du organiserar den. Du kan organisera innehållsförteckningen runt programmets skärmar, dess funktioner, sätt att använda den eller någon kombination därav.
- När du skriver ämnena ska du överväga annan information i hjälpfilen som användare vill ha snabb åtkomst till. Du kan skapa hopp eller hyperlänkar i hjälpfilstexten som ansluter till ämnena som har den informationen.
Steg 6. Inkludera skärmdumpar om det behövs
Många programfunktioner förklaras bäst med en kombination av text och grafik. Du kan skapa skärmdumpar med antingen programmet som kommer med ditt hjälpredigeringsverktyg eller med ett separat program, till exempel Microsoft Paint, Paint Shop Pro eller SnagIt.
- Text och skärmdumpar ska läggas upp tillsammans i ett ämne så att användarna kan se skärmdumpen och dess stödjande text utan onödig rullning. I många fall vill du visa en del av en programskärm istället för hela skärmen, eller visa skärmdumpen i en mindre storlek än originalet. Din skärmdump -applikation ska kunna ändra storlek på skärmdumpen utan att suddas eller förlora detaljer.
- Om du förväntar dig ändringar i användargränssnittet mellan testet och de slutliga versionerna av programmet, kanske du vill vänta med att skapa skärmdumpar tills du har den slutliga versionen av programmet att arbeta med.
Steg 7. Skapa en kartfil om det behövs
Vissa program inkluderar "Hjälp" -knappar för en användare att klicka och visa ämnet i hjälpfilen som specifikt beskriver hur den skärmen fungerar. Att visa ett ämne på detta sätt kallas kontextkänslig hjälp och kräver att du skapar en kartfil för programmeraren för att länka "Hjälp" -knappen till det specifika ämnet i din hjälpfil. Ditt hjälpredigeringsverktyg kan skapa ett åt dig, eller så kan programmeraren koda det och ge det till dig att inkludera i hjälpfilen.
Steg 8. Kompilera hjälpfilen
Kompilering skapar den faktiska hjälpfilen som kommer att inkluderas i programmet. För de flesta hjälpformat kommer detta att innehålla alla komponentfiler som skapades när du skapade hjälpfilen, även om vissa okompilerade hjälpformat också kräver att de enskilda hjälpämnesfilerna ingår i programmet.
Steg 9. Testa hjälpfilen
När du har sammanställt hjälpfilen måste du testa den för att se till att alla hyperlänkar ansluter till de ämnen de ska och att all grafik visas korrekt. Hjälpfilen måste också testas för att säkerställa att innehållet är korrekt och lämpligt för användarna och i ett konsekvent format. Du vill granska hjälpfilen själv och få dem som testar programmet att granska den också.
På större hjälpfilprojekt är kompilering och testning pågående processer. Du vill kompilera hjälpfilen och kontrollera ditt arbete flera gånger innan du skapar den slutliga versionen
Steg 10. Ge hjälpfilen till utvecklaren som ska inkluderas i programmet
Beroende på projektets art och hjälpfilformat kan du behöva förse utvecklaren med flera filer, inklusive en kartfil om det finns kontextkänsliga ämnen.
