Ikke alle der har skrevet software dokumentation, men alle har læst dokumentationen til softwaren , der forlod en masse at ønske. Når vi søger at finde oplysninger om et stykke software , vi ønsker at vide , hvad den gør, hvad operativsystemer og andre programmer det virker med , hvordan vi kan få det, og hvor meget det koster. Ting du skal
Et stykke software
Vis Flere Instruktioner
Forskellige former for software dokumentation
1
Skriv hvad softwaren gør. Efter at have læst dette dokument , bør læseren være i stand til at afgøre , om han har brug for softwaren. Vær sikker på at medtage alle de funktioner , som oftentimes kan være en liste over alle de software- funktionaliteter.
2
forklare, hvordan software- funktioner i forhold til andre stykker software . Dette kan nævne andre stykker software , der anses for at være competitors.Be sikker på at skitsere, hvad dette stykke software gør anderledes end de andre.
3
Skitsere de typer af grænseflader og kode, anvendes i softwaren . Dette afsnit bør lade læseren vide, hvad slags viden en bruger skal have til at arbejde med dette stykke software . Denne del af dokumentationen til softwaren anvendes af programmører og andre tekniske mennesker.
4
Lav et dokument for brugeren af softwaren , så alle, der læser det vil være i stand til at begynde at bruge programmet. Disse typer af dokumentation kan være tutorials. De kan også være lister over kommandoer eller indekser på, hvor brugerne kan finde de relevante oplysninger.
5.
Skriv dokumentation at salget folk kan bruge, når de sælger software.Make sikker på at du har medtaget alle de kapaciteter og salgssteder af softwaren.