Como esboçar documentos de redação técnica

Anonim

Como esboçar documentos de redação técnica. Um documento bem escrito não é criado por acaso. O material coberto em um relatório, manual ou outro documento técnico é planejado, organizado e depois gravado. O estágio de esboço de um documento é um passo fundamental e as chances são de que a informação não seja apresentada logicamente se um esboço não for criado. Delinear dá ao autor a chance de pensar sobre as informações que devem e não devem ser incluídas.

Brainstorm suas idéias. Anote todas as idéias em seu esboço que você acha que deveriam ser incluídas no documento técnico. Não se preocupe com a ordem das informações. Apenas importa que todas as informações sejam incluídas no processo de brainstorming.

Determinar o objetivo do documento técnico. Faça a si mesmo perguntas como quem lerá o documento, por que ele será lido e como será usado.

Decida que tipo de estrutura você gostaria de criar: histórico, cronológico, específico para geral, pequeno para grande, simples para complexo ou qualquer outra forma apropriada para o conteúdo. Pense no público e nas informações que você deseja apresentar. Certifique-se de que a maneira como a informação é organizada faz mais sentido para o tipo de informação que está sendo apresentada e para o público que estará lendo o documento técnico.

Organize as informações na ordem apropriada. Um esboço envolve o agrupamento das informações em seções e níveis lógicos. Você pode criar tópicos principais e sub-tópicos e sub-sub-tópicos.

Termine o esboço revendo as informações para verificar se os assuntos estão organizados de forma apropriada e lógica. Certifique-se de que você não está perdendo fatos importantes. Exclua qualquer informação que não seja relevante para o documento técnico.