Slik skisserer du tekniske skrivedokumenter

Anonim

Slik skisserer du tekniske skrivedokumenter. Et godt skrevet dokument opprettes ikke ved en tilfeldighet. Materialet som er omtalt i en rapport, manuell eller annet teknisk dokument, er planlagt, organisert og deretter skrevet. Utskriftsfasen av et dokument er et sentralt skritt, og sjansen er at informasjonen ikke vil bli presentert logisk dersom en oversikt ikke opprettes. Oppsummering gir forfatteren en sjanse til å tenke på informasjonen som bør og ikke skal inkluderes.

Brainstorm dine ideer. Skriv ned noen ideer i oversikten din, som du mener bør inkluderes i det tekniske dokumentet. Ikke vær bekymret for rekkefølgen av informasjonen. Det betyr bare at all informasjon er inkludert i brainstormingsprosessen.

Bestem formålet med det tekniske dokumentet. Still deg selv spørsmål som hvem som skal lese dokumentet, hvorfor skal det leses og hvordan skal det brukes.

Bestem hvilken type omriss du vil opprette: historisk, kronologisk, spesifikk for generell, liten til stor, enkel til kompleks eller annen form som passer til innholdet. Tenk på publikum og om informasjonen du vil presentere. Forsikre deg om at måten informasjonen blir arrangert gir mest fornuft til typen informasjon som presenteres og for publikum som vil lese det tekniske dokumentet.

Ordne informasjonen i riktig rekkefølge. En oversikt innebærer å gruppere informasjonen i logiske seksjoner og nivåer. Du kan opprette hovedemner og underemner og sub-underemner.

Fullfør oversikten ved å gjennomgå informasjonen for å verifisere at fagene er organisert hensiktsmessig og logisk. Pass på at du ikke mangler noen viktige fakta. Slett all informasjon som ikke er relevant for det tekniske dokumentet.

Anbefalt