Hvilke typer læsere er der til tekniske dokumenter?

2024 Forfatter: Lynn Donovan | [email protected]. Sidst ændret: 2023-12-15 23:45

Tekniske dokumenter omfatte notater, grafik, breve, løbesedler, rapporter, nyhedsbreve, præsentationer, websider, brochurer, forslag, instruktioner, anmeldelser, pressemeddelelser, kataloger, annoncer, håndbøger, forretningsplaner, politikker og procedurer, specifikationer, instruktioner, stilguider, dagsordener og så videre.

Desuden, hvad er de forskellige typer dokumentation?

Typer af systemet dokumentation indeholde et krav dokument , kildekode dokument , kvalitetssikring dokumentation , softwarearkitektur dokumentation , løsningsinstruktioner og en hjælpevejledning til avancerede brugere. Typer af bruger dokumentation omfatter træningsmanualer, brugermanualer, release notes og installationsvejledninger.

Udover ovenstående, hvad er et teknisk publikum? Det publikum af en teknisk rapport - eller et hvilket som helst stykke skrift for den sags skyld - er den tilsigtede eller potentielle læser eller læsere. For de fleste teknisk forfattere, er dette den vigtigste overvejelse ved planlægning, skrivning og gennemgang af et dokument.

Hvem er derfor læsere af teknisk skrivning?

I teknisk skrivning vil dit publikum ofte passe ind i en af følgende kategorier:

• Executives-De, der finansierer produktet.
• Eksperter-Dem, der kommer med ideer om produktet.
• Teknikere - dem, der bygger produktet.
• Ikke-specialister - Slutbrugeren.

Hvad skal medtages i teknisk dokumentation?

Det introducerer læserne i titlen på dokument , dens forfatter(e), de(t) beskrevne emne(r), det eller de løste problemer, den eller de anvendte metoder og det overordnede formål med dokument . Forreste Sag af evt teknisk dokument skal omfatte følgende elementer: Titelside. Det burde omfatte titlen, forfatteren og datoen.