Computer document on desk

Att tänka på när du skriver programvarudokumentation

4 tips till dig som skriver programvarudokumentation

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.

Här har AFRYs specialister inom Teknisk dokumentation och tillhörande digitala programvaror samlat de 4 viktigaste sakerna att tänka på när du skriver programvarudokumentation:

  1. Ta reda på varför dokumentationen behövs
  2. Se till att du förstår slutanvändarna
  3. Välj rätt format att publicera din dokumentation
  4. Använd ett system som är byggt för att producera teknisk dokumentation

Gör det enklare för dig att skriva programvarudokumentation genom att följa dessa steg!

Zert CLM Digital product working-980x490_usat.jpg

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.

Användarträff teknikinformation mjukvara

Förutom att det kan finnas krav att dokumentation måste finnas för att uppfylla lagkrav som t.ex. maskindirektivet så finns det flera andra viktiga användingsområden för programvarudokumentation.

Det kan vara till exempel att:

  • underlätta marknadsföring av programvaran - en bra programvarudokumentation hjälper den som ska förstå vad som ska marknadsföras, det finns dessutom välformulerade stycken att utgå ifrån.
  • höja företagets image - en smart och snygg bruksanvisning är lika viktigt för varumärket som förpackningen den kommer i, det vet nog alla som någon gång försökt montera en "gör det själv möbel".
  • sänka kostnaderna för kundsupport - en bra programvarudokumentation ger snabbt en bra överblick av funktioner, är lätt att hitta i och hjälper användaren att göra rätt från start.

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. Bland det viktigaste att komma ihåg är att slutanvändare sällan är intresserade av exakt hur programvaran fungerar. De är intresserade av vad programvaran kan göra för dem.

Identifiera helt enkelt de uppgifter som krävs för att utföra jobbet slutanvändarna vill ha gjort samt vilka och i vilken ordning uppgifter behöver utföras för att slutföra arbetet.

    Gör så här:

    • 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.

     

    hero 3

    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.

    Zert CLM teknisk dokumentation user-manual-img-4 product preview mock up

    Referenshandboken

    Referenshandboken förklarar varje funktion i ett program (knapp, flik, fält och dialogruta) och beskriver hur de fungerar.
    Beroende på vad användaren visar på skärmen när de klickar på hjälpknappen visas relevant information därefter.
    Många hjälpfiler dokumenteras ofta i detta format.

    Användarmanualen

    Användarmanualen beskriver hur man använder programvaran för att utföra en specifik uppgift, även om vissa hjälpfiler också innehåller ämnen om hur du utför vissa exakta uppgifter.
    Den är vanligtvis formaterad som PDF-file eller tryckt guide.

    4. Använd ett system som är byggt för att producera teknisk dokumentation

    En fråga som många utvecklare ställer är: ska jag använda Word för att skriva min produktdokumentation?
    Eftersom det är lättillgängligt och de flesta har goda kunskaper i hur det används är det 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.
    Men ett program för ordbehandling är inte gjort för att producera teknisk dokumentation. Word är jättebra för att skriva rapporter, brev och andra texter men flera vitala funktioner saknas för att skapa ett robust innehåll för en bruksanvisning. Även om formaterings funktionerna för rubrik-hierarkier och avsnitt är utvecklade så saknas de helt för layout, fördelning och placering av bild och text. Vill du kunna trycka bruksanvisningen blir du dessutom tvungen att göra om hela produkten i ett annat program eftersom upplösningskvaliteten inte är tillräcklig för tryckta bruksanvisningar.

    Zert CLM teknisk dokumentation Reservdelskatalog till webbförsäljning 57297-1.png

    Bra investering

    Att skriva en manual med hög kvalitet kan vara den bästa investeringen som ditt företag gör för användarupplevelsen, därför borde du använda ett system för teknisk dokumentation som ser till att du så enkelt som möjligt kan skapa, samla, underhålla och publicera flerspråkig teknisk dokumentation och eftermarknadsmaterial.

    Zert CLM är dessutom kraftfullt, användarvänligt och lätt att anpassa efter dina behov.