1. Ta reda på varför dokumentationen behövs
Det viktigaste skälet att dokumentera programvara är att hjälpa användarna förstå hur man använder en programvara, men det finns flera andra viktiga skäl. En anledning är att underlätta marknadsföring av programvaran, höja företagets image och att sänka kostnaderna för kundsupport. Det kan också finnas krav att dokumentation måste finnas för att uppfylla lagkrav som t.ex. maskindirektivet.
2. Se till att du förstår slutanvändarna
Det finns flera bra sätt att ta reda på vilken hjälp slutanvändarna behöver av dokumentationen.
- Fundera över vilka de olika slutanvändarna kan tänkas vara och vad de jobbar med. Är det någon som har teknisk kunskap och använder liknande program varje dag, eller är det sällananvändare som vid få tillfällen jobbar med en dator.
- Ett annat sätt kan vara att intervjua några potentiella användare för att ta reda på vilken nivå de ligger på. Att kunna intervjua potentiella slutanvändare är en viktig färdighet för en bra teknisk skribent.
- Granska de befintliga dokumentationerna, särskilt de tidiga versionerna av programvaran. Titta på de funktionella specifikationerna så att du vet vilken information som användarna måste få för att kunna använda programvaran.
Glöm inte att slutanvändare inte är intresserade av hur programvaran fungerar. Snarare är de intresserade av vad programvaran kan göra för dem. Identifiera helt enkelt de uppgifter som krävs för att utföra jobbet och de uppgifter som måste utföras innan de andra kan slutföras.
3. Välj rätt format att publicera din dokumentation
Många programvarudokumentationer är strukturerade i ett av två format: användarmanualen och referenshandboken. I vissa fall är en kombination av båda formaten den bästa strukturen.
Referenshandboken förklarar varje funktion i ett program (knapp, flik, fält och dialogruta) och hur de fungerar. Många hjälpfiler dokumenteras ofta i detta format. Beroende på vad användaren visar på skärmen när de klickar på hjälpknappen visas relevant information därefter.
Den andra, Användarmanualen beskriver hur man använder programvaran för att utföra en specifik uppgift. Användarmanualen är vanligtvis formaterade som PDF-filer eller tryckta guider. Även om vissa hjälpfiler också innehåller ämnen om hur du utför vissa exakta uppgifter.
Ett webbaserat system för teknisk dokumentation som Zert CLM kan generera flera olika filformat från en källa inklusive Word, PDF, HTML, vilket innebär att du inte låser dig till ett format utan får flera möjligheter.
4. Använd ett system som är byggt för att producera teknisk dokumentation
Det är lätt att dra slutsatsen att ett ordbehandlingsprogram som Microsoft Word är det rätta verktyget för att skriva den dokumentation du vill ha. En fråga som många utvecklare ställer är: ska jag använda Word för att skriva min produktdokumentation?
Ett program för ordbehandling är inte gjort för att producera teknisk dokumentation. Att skriva en manual med hög kvalitet kan vara den bästa investeringen som ditt företag gör, därför borde du använda ett system för teknisk dokumentation.
Att skriva programvarudokumentation för slutanvändare måste inte vara en pärs och resultatet borde inte vara ett tråkigt dokument som användarna ignorerar. Gör det enklare för dig genom att följa dessa 5 tips. Nu är det bara att börja skriva!
