Ikke alle som har skrevet programvare dokumentasjon, men alle har lest dokumentasjonen for programvaren som venstre mye å være ønsket . Når vi er ute etter å finne informasjon om et stykke programvare , ønsker vi å vite hva den gjør, hva operativsystemer og andre programmer det fungerer med , hvordan vi kan få det, og hvor mye det koster. Du trenger
Et stykke programvare
Vis flere instruksjoner
Ulike typer programvare dokumentasjon
en
Skriv hva programvaren gjør. Etter å ha lest dette dokumentet , må leseren kunne avgjøre om han trenger programvaren. Sørg for å inkludere alle de evner, som ofte kan være en liste over alle programvare funksjonaliteter .
2
Forklar hvordan programvaren fungerer i forhold til andre deler av programvaren . Dette kan nevne andre deler av programvaren som anses å være competitors.Be sikker på å skissere hva dette stykke programvare gjør annerledes enn de andre.
3
Outline hvilke typer grensesnitt og kode som brukes i programvaren. Denne delen skal la leseren vite hva slags kunnskap som en bruker skal ha til å jobbe med dette stykke programvare . Denne delen av dokumentasjonen for programvaren brukes av programmerere og andre tekniske folk .
4
Gjør et dokument for brukeren av programvaren, slik at alle som leser den vil være i stand til å begynne å bruke programmet . Disse typer dokumentasjon kan være tutorials . De kan også være lister over kommandoer eller indekser av hvor brukerne kan finne relevant informasjon.
5
Skriv dokumentasjonen at salget folk kan bruke når de selger software.Make at du har tatt alle evner og salgsargumenter av programvaren .