Gratis trin for trin instruktioner 
Hvis kildekoden er særlig lang, kan den dokumenteres i form af en hjælpefil, som kan indekseres og søges med nøgleord. Dette er en særlig fordel for applikationer, hvor programlogikken er fragmenteret over mange sider og indeholder en række yderligere filer, såsom med visse webapplikationer. Nogle programmeringssprog, såsom Java og .NET Framework (Visual Basic.NET, C#), har deres egne standarder for dokumentation af koden. I disse tilfælde skal du følge standarderne for, hvor meget af dokumentationen, der skal indgå i kildekoden. 
Tekstbehandlingsprogrammer til Microsoft Word er tilstrækkelige til at lave separate tekstfiler til dokumentation, så længe dokumentationen er ret kort og enkel. Til lange, komplekse tekstfiler foretrækker mange tekniske forfattere et dokumentationsværktøj som Adobe FrameMaker. Hjælpefiler til dokumentation af kildekoden kan fremstilles med ethvert hjælpeværktøj, såsom RoboHelp, Help and Manual, Doc-To-Help, MadCap Flare eller HelpLogix. 
Se på de funktioner, dine potentielle brugere har. En systemadministrator er sandsynligvis ekspert i en række softwareapplikationer, mens en dataindtastningsassistent sandsynligvis kun kender det program, han eller hun bruger til at indtaste data. Se på brugerne selv. Mens jobtitler normalt angiver, hvad folk gør, kan der være betydelige forskelle i, hvordan bestemte stillinger besættes i en organisation. Ved at interviewe potentielle brugere kan du få en idé om, hvorvidt dit indtryk af, hvad deres position indikerer, er korrekt eller ej. Se eksisterende dokumentation. Dokumentation for tidligere versioner af softwaren (samt funktionelle specifikationer) giver en indikation af, hvad brugeren skal vide for at bruge programmet. Du skal dog huske på, at slutbrugere ikke rigtig er interesserede i, hvordan programmet fungerer, men i hvad det kan gøre for dem. Bestem de opgaver, der skal udføres for at udføre en opgave, og hvilke opgaver, der skal udføres, før disse opgaver kan udføres. 
En referencevejledning er viet til at forklare de individuelle funktioner i en softwareapplikation (knapper, faner, felter og dialogboks) og hvordan de fungerer. Mange hjælpefiler er skrevet i dette format, især kontekstafhængig hjælp, der viser et relevant emne, når en bruger klikker på knappen Hjælp på en bestemt skærm. En brugervejledning forklarer, hvordan man bruger softwaren til at udføre en bestemt opgave. Brugervejledninger er ofte formateret som trykte vejledninger eller PDF`er, selvom nogle hjælpefiler indeholder emner om, hvordan man udfører visse opgaver. (Disse hjælpeemner er normalt ikke kontekstafhængige, selvom de kan være knyttet til emner, der er.) Brugervejledninger kommer ofte i form af vejledninger, med en oversigt over de opgaver, der skal udføres i introduktionen og instruktioner givet i nummererede trin. 
Hjælpefiler og onlinehjælp skal være indekseret og søgbare med nøgleord, så brugerne hurtigt kan finde de oplysninger, de har brug for. Mens hjælpefilbyggere automatisk kan generere indekser, er det ofte bedre at oprette indekset manuelt ved at bruge termer, som brugere normalt vil søge efter. 
Skrive dokumentation til software
Indhold
God softwaredokumentation, hvad enten det er et specifikationsdokument til programmører og testere, et teknisk dokument til kolleger eller softwaremanualer og hjælpefiler til slutbrugere, hjælper den person, der skal arbejde med softwaren, med at forstå alle dens funktioner og funktioner. God softwaredokumentation er specifik, kortfattet og relevant og giver alle vigtige oplysninger til den person, der bruger softwaren. Nedenfor finder du instruktioner til, hvordan du skriver softwaredokumentation til tekniske brugere og slutbrugere.
Trin
Metode 1 af 2: Skrivning af softwaredokumentation til tekniske brugere
1. Beslut hvilke oplysninger der skal medtages. Softwarespecifikationer fungerer som vejledninger for brugergrænsefladedesignere, programmører, der skriver koden, og testere, der verificerer, at softwaren fungerer efter hensigten. De nøjagtige oplysninger afhænger af det pågældende program, men kan omfatte et af følgende:
- De vigtigste filer i applikationen. Disse kan være filer oprettet af udviklingsteamet, databaser, der er tilgået under programdrift, og tredjepartsværktøjer.
- Funktioner og underrutiner. Dette er en forklaring på, hvad hver funktion eller subrutine gør, inklusive alle input- og outputværdier.
- Programvariable og konstanter, og hvordan de bruges i applikationen.
- Den generelle programstruktur. For en disk-baseret applikation kan det være en beskrivelse af programmets individuelle moduler og biblioteker, mens det for en webapplikation kan beskrive hvilke sider der bruger hvilke filer.
2. Beslut hvor meget af dokumentationen der skal med i programkoden, og hvor meget der skal holdes adskilt. Jo mere teknisk dokumentation, der allerede er udviklet inden for programmets kildekode, jo lettere bliver det at opdatere og vedligeholde den sammen med koden, samt at dokumentere forskellige versioner af den originale applikation. Dokumentation i kildekoden skal som minimum forklare formålet med funktioner, underrutiner, variabler og konstanter.
3. Vælg det rigtige dokumentationsværktøj. Til en vis grad bestemmes dette af det sprog, som koden er skrevet på (såsom C++, C#, Visual Basic, Java eller PHP), da der findes specifikke værktøjer til disse og andre sprog. I andre tilfælde bestemmer typen af dokumentation, hvilket værktøj der skal bruges.
Metode 2 af 2: Skrivning af softwaredokumentation til slutbrugere
1. Bestem de forretningsmæssige årsager til din dokumentation. Mens den funktionelle årsag til at dokumentere software er at hjælpe brugere med at forstå, hvordan de bruger applikationen, er der andre grunde, såsom at hjælpe med at markedsføre softwaren, forbedre virksomhedens image og vigtigst af alt at reducere omkostningerne til teknisk support. I nogle tilfælde er dokumentationen nødvendig for at overholde visse regler eller andre lovkrav.
- Softwaredokumentation bør dog på ingen måde være en erstatning for dårligt interfacedesign. Hvis en applikation kræver sider med dokumentation som vejledning, er det bedre at ændre skærmdesignet til noget mere intuitivt.
2. Forstå den målgruppe, du skriver dokumentationen til. I de fleste tilfælde har softwarebrugere ringe viden om computere ud over de opgaver, de kan udføre med de applikationer, de bruger. Der er flere måder at bestemme, hvad de har brug for, og hvordan din dokumentation kan opfylde dem.
3. Bestem det korrekte format for dokumentationen. Softwaredokumentation kan struktureres i 1 af 2 formater: manualen og brugermanualen. Nogle gange er en kombination af begge formater den bedste tilgang.
4. Beslut, hvilken form dokumentationen skal have. Softwaredokumentation kan antage mange former: manualer, PDF-dokumenter, hjælpefiler eller onlinehjælp. Hver formular er designet til at vise brugeren brugen af hver af programmets funktioner, hvad enten det er i form af en gennemgang eller tutorial; i tilfælde af hjælpefiler og onlinehjælp kan det være tekst samt demonstrationsvideoer samt billeder.
5. Vælg et passende dokumentationsværktøj. Trykte eller PDF-manualer kan skrives ved hjælp af et tekstbehandlingsprogram såsom Word eller en avanceret teksteditor såsom FrameMaker, afhængigt af deres længde og kompleksitet. Hjælpefiler kan skrives med et specielt forfatterværktøj såsom RoboHelp, Help and Manual, Doc-To-Help, Flare, HelpLogix eller HelpServer.
Tips
- Teksten skal være organiseret, så den er let at læse, med billeder så tæt som muligt på den tekst, den refererer til. Inddel dokumentationen logisk i afsnit, afsnit og emner. Hvert afsnit eller emne skal forklare et enkelt problem, det være sig en enkelt programfunktion eller en opgave. Relaterede problemer kan forklares, hvor det er relevant, ved hjælp af `Se også`-lister eller hyperlinks som nævnt ovenfor.
- Ethvert af de ovennævnte dokumentationsværktøjer kan suppleres med et skærmbilledeprogram, såsom Snagit, hvis dokumentationen kræver nogle skærmbilleder. Som med anden dokumentation bør skærmbilleder inkluderes for at hjælpe med at forklare, hvordan softwaren fungerer, ikke for at forvirre brugeren.
- Tone er meget vigtigt, især når du skriver softwaredokumentation til slutbrugere. Henvend dig til brugere i anden person ("dig") i stedet for tredje person ("bruger").
Fornødenheder
- Softwaredokumentation/hjælpefilværktøj
- Skærmbillede værktøj
Artikler om emnet "Skrive dokumentation til software"
Оцените, пожалуйста статью
Populær
