Vad är mjukvarudokumentation?
Mjukvarudokumentation är den skriftliga beskrivningen av hur en programvara fungerar och hur man använder den. Denna dokumentation är avsedd att hjälpa användare, utvecklare och andra intressenter att förstå, använda och underhålla programvaran på ett effektivt sätt.
Mjukvarudokumentationen inkluderar ofta en mängd olika dokument såsom användarhandböcker, API-dokumentation och systemdokumentation.
Innan du sätter igång
Innan du börjar skriva mjukvarudokumentationen finns det vissa saker som bör vara på plats;
- Ha koll på målgruppen. För att dokumentationen ska bli användbar måste den vara skriven för mottagaren. Därför måste du ha kunskap om målgruppen och dess kunskapsnivå. Använder du fackspråk måste du vara säker på att målgruppen förstår det. Lämna alltid förklaringar till sådana uttryck för att försäkra dig om att det blir tydligt.
- Ge uppdraget till rätt person. Det är en god idé att låta en teknisk skribent skriva mjukvarudokumentationen. Ofta låter man utvecklare skriva dokumentationen på grund av deras kunskap om produkten. Dock har utvecklare oftast inte rätt erfarenhet för att skapa en bra struktur och använda rätt språk för att dokumenten ska bli användbara.Det bästa är om man väljer en teknisk skribent med grundläggande tekniska kunskaper, som sedan i samarbete med utvecklare kan ta fram dokumentationen. Den tekniska skribentens arbete underlättas om den kan ställa frågor och ta hjälp av utvecklare i frågor där hen inte har all teknisk kunskap.
- Sätt ett mål. Det är bra om man har en bild av vad man vill uppnå med dokumentationen. Vad ska den användas till och vilka dokument bör den innehålla för att bli fullständig. Om man har detta på plats blir det lättare att komma igång.
- Bestäm format. Du vill att dokumentationen ska vara tillgänglig för målgruppen och i ett format som passar för användningsområdet. Exempel på format kan vara en användarhandbok.
Sätt en bra struktur
När det är dags att börja skriva är det viktigt att ha en bra struktur och att viktig information finns med. Här är några tips som kan vara behjälpliga;
- Inled dokumentationen med en översikt. En övergripande sammanfattning av programmets eller tjänstens funktioner. Det kan också vara bra att beskriva grundläggande terminologi och procedurer för att användaren enklare ska kunna ta till sig dokumentationen.
- Inkludera verkliga exempel. För att tydliggöra kan det vara en god ide att inkludera skärmdumpar, kodsnuttar och annat innehåll som kan göra det extra tydligt hur man går tillväga i specifika uppgifter.
- Beskriv vanliga problem. Glöm inte att det inte alltid går som det är tänkt, du bör därför alltid inkludera beskrivningar av alla tänkbara scenarier och hur man tar sig vidare från dem. Ägna gärna ett avsnitt åt felsökning och vanliga frågor med lösningar.
- Använd ett tydligt språk. Använd ett språk som användaren förstår. Vid användning av fackspråk eller termer som vissa i målgruppen eventuellt inte förstår, se till att dessa är beskrivna. Förkortningar bör skrivas ut första gången de används.
- Säkerställ tydlig navigering. Glöm inte innehållsförteckningar och väl fungerande sökfunktioner. De har en betydande roll i användarens förmåga att hitta den information de söker.
Ta hjälp av Dokumentera för att skriva mjukvarudokumentationen
Dokumentera är ett ambitiöst och växande konsultbolag specialiserat på att skriva, analysera och organisera information och teknisk dokumentation. Sedan Dokumentera startade sin verksamhet 2007 har vi hjälpt ett stort antal nöjda företag och organisationer i olika branscher med kvalitativ dokumentation för både internt och externt bruk. Kontakta oss gärna här så berättar vi mer!