Kakšne so vrste bralnikov tehnične dokumentacije?

2024 Avtor: Lynn Donovan | [email protected]. Nazadnje spremenjeno: 2023-12-15 23:53

Tehnični dokumenti vključujejo beležke, grafike, pisma, letake, poročila, glasila, predstavitve, spletne strani, brošure, predloge, navodila, ocene, sporočila za javnost, kataloge, oglase, priročnike, poslovne načrte, politike in postopke, specifikacije, navodila, slogovne vodnike, dnevne rede in tako naprej.

Poleg tega, katere so različne vrste dokumentacije?

Vrste sistema dokumentacijo vključujejo zahteve dokument , izvorna koda dokument , Zagotavljanje kakovosti dokumentacijo , arhitektura programske opreme dokumentacijo , navodila za rešitev in vodnik za pomoč za napredne uporabnike. Vrste uporabnika dokumentacijo vključujejo priročnike za usposabljanje, uporabniške priročnike, opombe ob izdaji in vodnike za namestitev.

Kaj je poleg zgoraj navedenega še tehnično občinstvo? The občinstvo od a tehnični poročilo – ali katero koli pisno besedilo – je predvideni ali potencialni bralec ali bralci. Za večino tehnični pisci, je to najpomembnejši dejavnik pri načrtovanju, pisanju in pregledovanju dokumenta.

Kdo so torej bralci tehničnega pisanja?

Pri tehničnem pisanju se vaše občinstvo pogosto uvršča v eno od naslednjih kategorij:

• Vodstvo – tisti, ki financirajo izdelek.
• Strokovnjaki - Tisti, ki dajejo ideje o izdelku.
• Tehniki - Tisti, ki izdelujejo izdelek.
• Nestrokovnjaki - končni uporabnik.

Kaj je treba vključiti v tehnično dokumentacijo?

Bralce seznani z naslovom dokument , njegove avtorje(-e), opisano(-e) temo(-e), rešeno(-e) vprašanje(-e), uporabljeno(-e) metodo(-e) in splošni namen dokument . Prednja zadeva katerega koli tehnični dokument mora vključujejo naslednje elemente: Naslovna stran. Moralo bi vključujejo naslov, avtor in datum.