Programvarudokumentation - tryckta användarmanualer, on-line (online) dokumentation och hjälptext som beskriver hur man använder programvaran [1] .
Dokument - ett element av dokumentation: riktad information avsedd för en specifik publik, placerad på ett specifikt medium (till exempel i en bok, på en disk, i ett snabbreferenskort) i ett givet format [1] .
Programdokumentation - dokument som innehåller, beroende på syftet, de data som behövs för utveckling, produktion, drift, underhåll av ett program eller ett mjukvaruverktyg [2] .
Det finns fyra huvudtyper av programvarudokumentation:
Designdokumentation beskriver vanligtvis produkten i allmänna termer. Utan att beskriva hur något kommer att användas, svarar det snarare på frågan "varför är det så." Till exempel, i ett designdokument, kan en programmerare beskriva skälen till varför datastrukturerna är organiserade som de är. Anledningarna till varför en klass är utformad på ett visst sätt beskrivs, mönster lyfts fram och i vissa fall ges även idéer om hur förbättringar kan göras i framtiden. Inget av detta finns i den tekniska eller användardokumentationen, men det är verkligen viktigt för projektet.
När man skapar ett program är det oftast inte tillräckligt med kod . Lite text bör tillhandahållas som beskriver olika aspekter av exakt vad koden gör. Sådan dokumentation ingår ofta direkt i källkoden eller tillhandahålls med den.
Sådan dokumentation är mycket teknisk till sin natur och används främst för att definiera och beskriva API:er , datastrukturer och algoritmer .
Ofta, när man sammanställer teknisk dokumentation, används automatiserade verktyg - dokumentationsgeneratorer , såsom Doxygen , javadoc , NDoc och andra. De hämtar sin information från speciellt formaterade kommentarer i källkoden och skapar hjälpmanualer i något format, som text eller HTML .
Användningen av dokumentationsgeneratorer och dokumentationskommentarer har visat sig vara ett praktiskt verktyg av många programmerare, av olika anledningar. I synnerhet med detta tillvägagångssätt är dokumentationen en del av källkoden, och samma verktyg kan användas för att bygga programmet och bygga dokumentationen för det samtidigt. Det gör det också lättare att hålla dokumentationen uppdaterad.
Till skillnad från teknisk dokumentation, som fokuserar på koden och hur den fungerar, beskriver användardokumentationen bara hur man använder programmet.
Om produkten är ett mjukvarubibliotek blir användardokumentation och koddokumentation mycket nära, nästan likvärdiga begrepp. Men i allmänhet är det inte så.
Vanligtvis är användardokumentation en användarmanual som beskriver varje funktion i programmet, samt stegen att följa för att använda den funktionen. Bra användardokumentation går ännu längre och ger instruktioner om vad man ska göra om problem uppstår. Det är mycket viktigt att dokumentationen inte är vilseledande och uppdaterad. Ledarskapet bör ha en tydlig struktur; mycket användbart om det finns ett tvärgående index . Logisk sammanhållning och enkelhet är också av stor vikt.
Det finns tre sätt att organisera användardokumentation. Den inledande guiden , som är mest användbar för nya användare, leder dig genom en rad steg för att slutföra några vanliga uppgifter. Ett tematiskt tillvägagångssätt, där varje kapitel i manualen fokuserar på ett visst ämne, är mer lämpligt för avancerade användare. I det sista, tredje tillvägagångssättet är kommandona eller uppgifterna organiserade som en alfabetisk referens - ofta väl mottagna av avancerade användare som vet väl vad de letar efter. Användarklagomål hänför sig vanligtvis till det faktum att dokumentationen endast täcker ett av dessa tillvägagångssätt, och därför är väl lämpat för endast en klass av användare.
I många fall begränsar mjukvaruproduktutvecklare uppsättningen av användardokumentation till endast det inbyggda hjälpsystemet ( engelsk onlinehjälp ), som innehåller hjälpinformation om kommandon eller menyalternativ. Jobbet med att utbilda nya användare och stödja utvecklande användare överlåts till privata utgivare, som ofta ger betydande hjälp till utvecklare.
För många applikationer är det nödvändigt att ha reklammaterial bredvid sig för att intressera människor genom att uppmärksamma produkten. Denna form av dokumentation är avsedd att:
En av de goda marknadsföringsmetoderna är att tillhandahålla en slogan – en enkel catchy fras som illustrerar vad vi vill förmedla till användaren, samt beskriver känslan som produkten skapar.
Det händer ofta att produktboxen och annat marknadsföringsmaterial ger en tydligare bild av möjligheterna och sätten att använda programmet än något annat.
| Mjukvaruutveckling | |
|---|---|
| Bearbeta |
|
Koncept på hög nivå | |
| Vägbeskrivning |
|
| Utvecklingsmetoder _ | |
| Modeller |
|
| Anmärkningsvärda siffror |
|