Hur skapar jag en hjälpfil?

Skaffa en kopia av programvaran 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 avviker programmeraren från specifikationerna, baserat på kort utvecklingstid eller inte kan koda en viss funktion.

Skaffa ett verktyg för redigering av hjälp. Även om det är möjligt att skapa en hjälpfil för hand med hjälp av en.text-fil (.rtf), använder de flesta författare av en programvara för att skriva sina hjälpfiler, till exempel RoboHelp, Help and Manual, Doc-To -Hjälp, MadCap Flare eller HelpLogix. De flesta hjälpverktygsverktyg inkluderar en textredigerare eller arbetar 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å grafikredigerare 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 vardera sina egna format, liksom Sun Microsystems, med dess JavaHelp. Programvaruapplikationer 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älpförfattarverktyg du använder bör stödja det eller de hjälpformat du ska skapa hjälpfiler i.

Skapa hjälpprojektfilen. Ditt hjälpredigeringsverktyg skapar en hjälpprojektfil för dig baserat på det filnamn du anger och annan information. Huvudprojektfilen innehåller information om andra filer, som inkluderar en filens innehåll, en indexfil, en eller flera bildfiler och andra filer.

• Innehållsfilen innehåller texten i hjälpfilen som förklarar hur programvaran du dokumenterar fungerar. Texten är vanligtvis uppdelad i ämnen som täcker en viss 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ändarna kan använda för att välja ett ämne som ska visas, samt ett sökbart index i hjälpfilen.
• Bildfiler är grafiska filer på programskärmar eller delar av dessa skärmar som visas i hjälpfilen för att förbättra användarnas förmåga att förstå vad hjälpfilens text hänvisar till.

Justera storleken på hjälpfönstret. Om du inte skriver hjälpfilen för att visas i användarens webbläsare, kommer hjälpfilen att visas i sitt 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 den kommer i vägen för själva programmet. Huvudhjälpsfönstret är ofta i ett tri-rutigt format, med innehållsförteckningen till vänster och det valda ämnet till höger.

• Hjälpfiler kan också ha, utöver huvudfönstret, sekundära fönster som beskriver en viss funktion i detalj och automatiskt storleksändring av popup-fönster som ger korta beskrivningar av funktioner. Hjälpfiler kan också innehålla inbäddad text som endast visas när markerad text eller en knapp klickas.

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 lägger ditt hjälpförfattarverktyg till det i hjälpfils innehållsförteckning och index.

• Medan du kan bygga innehållsförteckningen när du går hjälper det dig att ha en plan för hur du organiserar den. Du kan ordna 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 ämnen, överväga annan information i hjälpfilen som användarna vill ha snabb åtkomst till. Du kan skapa hopp eller hyperlänkar i hjälpfilens text som ansluter till de ämnen som har den informationen.

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 applikationen som följer med ditt hjälpverktyg eller med en separat applikation, till exempel Microsoft Paint, Paint Shop Pro eller SnagIt.

• Text och skärmdumpar bör läggas samman i ett ämne så att användarna kan se skärmdumpen och dess stödtext 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ärmdumpapplikation ska kunna ändra storlek på skärmdumpen utan suddighet eller förlust av detaljer.
• Om du förväntar dig ändringar i användargränssnittet mellan test- och slutversionerna av programmet, kanske du vill skjuta upp skärmdumpar tills du har den slutliga versionen av programmet att arbeta med.

Skapa en kartfil om det behövs. Vissa program innehåller "Hjälp" -knappar för en användare att klicka och visa ämnet i hjälpfilen som specifikt beskriver hur 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 en åt dig, eller programmeraren kan koda den och ge den till dig att inkludera i hjälpfilen.

Kompilera hjälpfilen. Kompilering skapar den faktiska hjälpfilen som kommer att ingå i programmet. För de flesta hjälpformat innehåller alla komponenterna som skapades när du skapade hjälpfilen, även om vissa okompilerade hjälpformat också kräver att de enskilda hjälpfilerna ska ingå i programmet.

Testa hjälpfilen. När du har kompilerat 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 kommer att vilja granska hjälpfilen själv och låta personerna som testar applikationen granska den också.

• På större hjälpfilprojekt är sammanställning och testning pågående processer. Du vill kompilera hjälpfilen och kontrollera ditt arbete flera gånger innan du skapar den slutliga versionen.