Softwaredokumentation - trykte brugermanualer, on-line (online) dokumentation og hjælpetekst, der beskriver, hvordan man bruger softwareproduktet [1] .
Dokument - et element af dokumentation: målrettet information beregnet til en specifik målgruppe, placeret på et bestemt medie (for eksempel i en bog, på en disk, i et hurtig referencekort) i et givet format [1] .
Programdokumentation - dokumenter, der afhængigt af formålet indeholder de data, der er nødvendige for udvikling, produktion, drift, vedligeholdelse af et program eller et softwareværktøj [2] .
Der er fire hovedtyper af softwaredokumentation:
Designdokumentation beskriver normalt produktet i generelle vendinger. Uden at beskrive, hvordan noget vil blive brugt, svarer det snarere på spørgsmålet "hvorfor er det sådan." For eksempel kan en programmør i et designdokument beskrive begrundelsen for, hvorfor datastrukturerne er organiseret, som de er. Årsagerne til, at en klasse er designet på en bestemt måde, beskrives, mønstre fremhæves , og i nogle tilfælde gives endda ideer til, hvordan forbedringer kan foretages i fremtiden. Intet af dette er i den tekniske eller brugerdokumentation, men det er alt sammen meget vigtigt for projektet.
Når du opretter et program, er kode alene normalt ikke nok. Der bør gives en tekst, der beskriver forskellige aspekter af, hvad koden præcis gør. Sådan dokumentation er ofte inkluderet direkte i kildekoden eller leveret sammen med den.
Sådan dokumentation er meget teknisk af natur og bruges primært til at definere og beskrive API'er , datastrukturer og algoritmer .
Ofte, når der kompileres teknisk dokumentation, bruges automatiserede værktøjer - dokumentationsgeneratorer , såsom Doxygen , javadoc , NDoc og andre. De tager deres oplysninger fra specielt formaterede kommentarer i kildekoden og opretter hjælpemanualer i et eller andet format, såsom tekst eller HTML .
Brugen af dokumentationsgeneratorer og dokumentationskommentarer har vist sig at være et praktisk værktøj af mange programmører af forskellige årsager. Specielt med denne tilgang er dokumentationen en del af kildekoden, og de samme værktøjer kan bruges til at bygge programmet og bygge dokumentationen til det på samme tid. Det gør det også nemmere at holde dokumentationen opdateret.
I modsætning til teknisk dokumentation, som fokuserer på koden, og hvordan den fungerer, beskriver brugerdokumentationen kun, hvordan programmet skal bruges.
Hvis produktet er et softwarebibliotek , bliver brugerdokumentation og kodedokumentation meget tætte, næsten tilsvarende begreber. Men generelt er det ikke tilfældet.
Normalt er brugerdokumentation en brugervejledning , der beskriver hver funktion i programmet, samt de trin, der skal følges for at bruge denne funktion. God brugerdokumentation går endnu længere og giver instruktioner om, hvad man skal gøre, hvis der opstår problemer. Det er meget vigtigt, at dokumentationen ikke er vildledende og opdateret. Ledelsen bør have en klar struktur; meget nyttigt, hvis der er et tværgående indeks . Logisk sammenhæng og enkelhed er også af stor betydning.
Der er tre tilgange til at organisere brugerdokumentation. Den introduktionsvejledning , som er mest nyttig for nye brugere, leder dig gennem en række trin for at udføre nogle almindelige opgaver. En tematisk tilgang, hvor hvert kapitel i manualen fokuserer på et bestemt emne, er mere velegnet til avancerede brugere. I den sidste, tredje tilgang er kommandoerne eller opgaverne organiseret som en alfabetisk reference – ofte godt modtaget af avancerede brugere, som godt ved, hvad de leder efter. Brugerklager relaterer sig normalt til, at dokumentationen kun dækker én af disse tilgange, og derfor er velegnet til kun én klasse af brugere.
I mange tilfælde begrænser softwareproduktudviklere sættet af brugerdokumentation til kun det indbyggede hjælpesystem ( engelsk onlinehjælp ), der indeholder hjælpeoplysninger om kommandoer eller menupunkter. Jobbet med at uddanne nye brugere og støtte udviklende brugere er overladt til private udgivere, som ofte yder betydelig assistance til udviklere.
For mange applikationer er det nødvendigt at have reklamemateriale ved siden af sig for at interessere folk ved at henlede deres opmærksomhed på produktet. Denne form for dokumentation har til formål at:
En af de gode markedsføringsmetoder er at give et slogan – en simpel fængende sætning, der illustrerer, hvad vi ønsker at formidle til brugeren, samt beskriver den følelse , som produktet skaber.
Det sker ofte, at produktboksen og andet markedsføringsmateriale giver et klarere billede af mulighederne og måderne at bruge programmet på end noget andet.
| Softwareudvikling | |
|---|---|
| Behandle |
|
Koncepter på højt niveau | |
| Vejbeskrivelse |
|
| Udviklingsmetoder _ | |
| Modeller | |
| Bemærkelsesværdige tal |
|