Hoe technische schrijvingsdocumenten schetsen

Anonim

Hoe technische schrijvingsdocumenten schetsen. Een goed geschreven document is niet toevallig gemaakt. Het materiaal dat in een rapport, handleiding of ander technisch document wordt behandeld, is gepland, georganiseerd en vervolgens geschreven. De overzichtsfase van een document is een belangrijke stap en de kans bestaat dat de informatie niet logisch wordt weergegeven als er geen overzicht wordt gemaakt. Het schetsen geeft de auteur een kans om na te denken over de informatie die wel en niet moet worden opgenomen.

Brainstorm uw ideeën. Noteer eventuele ideeën in uw overzicht waarvan u denkt dat ze in het technische document moeten worden opgenomen. Wees niet bezorgd over de volgorde van de informatie. Het maakt alleen uit dat alle informatie is opgenomen in het brainstormproces.

Bepaal het doel van het technische document. Stel jezelf vragen zoals wie het document zal lezen, waarom het zal worden gelezen en hoe het zal worden gebruikt.

Bepaal welk type omtrek u wilt maken: historisch, chronologisch, specifiek voor algemeen, van klein tot groot, eenvoudig te complex of elke andere vorm die geschikt is voor de inhoud. Denk aan het publiek en aan de informatie die u wilt presenteren. Zorg ervoor dat de manier waarop de informatie is geordend, het meest logisch is voor het type informatie dat wordt gepresenteerd en voor het publiek dat het technische document gaat lezen.

Schik de informatie in de juiste volgorde. Een overzicht omvat het groeperen van de informatie in logische secties en niveaus. U kunt hoofdonderwerpen en subonderwerpen en subsubthema's maken.

Beëindig de omtrek door de informatie te bekijken om te controleren of de onderwerpen op de juiste manier en logisch zijn georganiseerd. Zorg ervoor dat u geen belangrijke feiten mist. Verwijder alle informatie die niet relevant is voor het technische document.

Aanbevolen