Så här skisserar du tekniska skrivningsdokument

Anonim

Så här skisserar du tekniska skrivningsdokument. Ett välskriven dokument skapas inte av en slump. Materialet som ingår i en rapport, ett manuellt eller annat tekniskt dokument är planerat, organiserat och sedan skrivet. Dokumentets skisseringsstadium är ett viktigt steg och chansen är att informationen inte kommer att presenteras logiskt om en skiss inte skapas. Outlining ger författaren en chans att tänka på den information som borde och borde inte inkluderas.

Brainstorma dina idéer. Skriv ner några idéer i din översikt som du tycker bör ingå i det tekniska dokumentet. Var inte upptagen med informationens ordning. Det är bara viktigt att all information ingår i brainstormingsprocessen.

Bestämma syftet med det tekniska dokumentet. Fråga dig själv frågor som vem som ska läsa dokumentet, varför kommer det att läsas och hur kommer det att användas.

Bestäm vilken typ av skiss du vill skapa: historisk, kronologisk, specifik för generell, liten till stor, enkel att komplex eller någon annan form som är lämplig för innehållet. Tänk på publiken och om den information du vill presentera. Se till att det sätt på vilket informationen är ordnad ger mest mening åt vilken typ av information som presenteras och för publiken som läser det tekniska dokumentet.

Ordna informationen i lämplig ordning. En översikt involverar att gruppera informationen i logiska sektioner och nivåer. Du kan skapa huvudämnen och delämnen och underunderlag.

Avsluta konturen genom att granska informationen för att verifiera att ämnena är ordnade på ett korrekt och logiskt sätt. Se till att du saknar några viktiga fakta. Ta bort all information som inte är relevant för det tekniska dokumentet.