Sådan beskriver du tekniske skrivedokumenter

Anonim

Sådan beskriver du tekniske skrivedokumenter. Et velskrevet dokument skabes ikke tilfældigt. Materialet i en rapport, manuel eller andet teknisk dokument er planlagt, organiseret og derefter skrevet. Det skitserede trin i et dokument er et centralt skridt, og chancerne er, at oplysningerne ikke vil blive præsenteret logisk, hvis der ikke oprettes en oversigt. Outlining giver forfatteren en chance for at tænke på de oplysninger, der skal og bør ikke medtages.

Brainstorm dine ideer. Skriv ned eventuelle ideer i dit omrids, som du mener skal medtages i det tekniske dokument. Vær ikke bekymret for rækkefølgen af ​​oplysningerne. Det betyder bare, at al information er inkluderet i brainstormingsprocessen.

Bestem formålet med det tekniske dokument. Spørg dig selv spørgsmål som hvem der læser dokumentet, hvorfor bliver det læst og hvordan vil det blive brugt.

Bestem hvilken type omrids du vil oprette: historisk, kronologisk, specifik for generel, lille til stor, enkel til kompleks eller nogen anden form, der passer til indholdet. Tænk over publikum og om de oplysninger, du vil præsentere. Sørg for, at den måde, hvorpå oplysningerne er arrangeret, giver mest mening til den type information, der præsenteres, og til publikum, der læser det tekniske dokument.

Ordne oplysningerne i den rigtige rækkefølge. En oversigt involverer gruppering af informationen i logiske sektioner og niveauer. Du kan oprette hovedemner og underemner og underundergrupper.

Afslut oversigten ved at gennemgå oplysningerne for at kontrollere, at emnerne er organiseret korrekt og logisk. Sørg for, at du ikke mangler nogle vigtige fakta. Slet alle oplysninger, der ikke er relevante for det tekniske dokument.