Come delineare documenti di scrittura tecnica. Un documento ben scritto non è creato per caso. Il materiale trattato in un rapporto, manuale o altro documento tecnico è pianificato, organizzato e quindi scritto. La fase di definizione di un documento è un passaggio chiave e ci sono buone possibilità che le informazioni non vengano presentate logicamente se non viene creata una struttura. Delineare dà all'autore un'opportunità di pensare alle informazioni che dovrebbero e non dovrebbero essere incluse.
Brainstorm le tue idee. Annota eventuali idee nella tua struttura che ritieni debbano essere incluse nel documento tecnico. Non preoccuparti per l'ordine delle informazioni. Importa solo che tutte le informazioni siano incluse nel processo di brainstorming.
Determinare lo scopo del documento tecnico. Porsi domande come chi leggerà il documento, perché verrà letto e come verrà utilizzato.
Decidi quale tipo di struttura vorresti creare: cronologico, cronologico, specifico per generale, da piccolo a grande, da semplice a complesso o qualsiasi altra forma appropriata al contenuto. Pensa al pubblico e alle informazioni che vuoi presentare. Assicurati che il modo in cui le informazioni sono organizzate abbia più senso per il tipo di informazione che viene presentata e per il pubblico che leggerà il documento tecnico.
Disporre le informazioni nell'ordine appropriato. Uno schema comporta il raggruppamento delle informazioni in sezioni e livelli logici. È possibile creare argomenti principali e argomenti secondari e sotto-argomenti secondari.
Completare lo schema rivedendo le informazioni per verificare che i soggetti siano organizzati in modo appropriato e logico. Assicurati di non mancare alcun dato chiave. Elimina qualsiasi informazione che non è rilevante per il documento tecnico.
