Forfatter:
Randy Alexander
Opprettelsesdato:
26 April 2021
Oppdater Dato:
16 Kan 2024
Innhold
er en wiki, som betyr at mange artikler er skrevet av flere forfattere. For å lage denne artikkelen deltok 12 personer, noen anonyme, i utgaven og forbedringen over tid.God programvaredokumentasjon, enten det er et spesifikasjonsdokument for programmerere eller testere, et teknisk dokument for brukere eller programvarehåndbøker og filer for sluttbrukere, hjelper brukeren til å forstå funksjonaliteten og driften av programvaren. God programvaredokumentasjon er spesifikk, kortfattet, tilstrekkelig og gir all viktig informasjon til programvarebrukeren. Nedenfor finner du instruksjoner om hvordan du lager programvaredokumentasjon for tekniske brukere og sluttbrukere.
stadier
Metode 1 av 2:
Skriv programvaredokumentasjon for tekniske brukere
- 5 Velg riktig dokumentasjonsverktøy. Trykte brukerhåndbøker eller PDF-er kan skrives med et e-prosesseringsprogram som Word eller en sofistikert e-editor som FrameMaker, avhengig av lengde og kompleksitet. Hjelpefiler kan skrives med et verktøy for å designe online hjelp som RoboHelp, Help and Manual, Doc-To-Help, Flare, HelpLogix eller HelpServer. annonsering
Nødvendige elementer
- Et dokumentasjonsverktøy for programvare eller et verktøy for å designe onlinehjelp
- Et verktøy for å lage skjermbilder
