Cómo delinear documentos de escritura técnica

Anonim

Cómo esbozar documentos de escritura técnica. Un documento bien escrito no se crea por casualidad. El material cubierto en un informe, manual u otro documento técnico se planifica, organiza y luego se escribe. La etapa de esbozo de un documento es un paso clave y es probable que la información no se presente de manera lógica si no se crea un esquema. La descripción le da al autor la oportunidad de pensar acerca de la información que debe y no debe incluirse.

Piensa en tus ideas. Escriba cualquier idea en su esquema que considere que debería incluirse en el documento técnico. No se preocupe por el orden de la información. Solo importa que toda la información se incluya en el proceso de intercambio de ideas.

Determinar el propósito del documento técnico. Hágase preguntas como quién leerá el documento, por qué se leerá y cómo se usará.

Decida qué tipo de esquema le gustaría crear: histórico, cronológico, específico a general, pequeño a grande, simple a complejo o cualquier otra forma apropiada para el contenido. Piense en la audiencia y en la información que desea presentar. Asegúrese de que la forma en que se organiza la información tiene más sentido para el tipo de información que se presenta y para la audiencia que leerá el documento técnico.

Organice la información en el orden apropiado. Un esquema implica agrupar la información en secciones y niveles lógicos. Puede crear temas principales y subtemas y subtemas secundarios.

Finalice el esquema revisando la información para verificar que los temas estén organizados de manera adecuada y lógica. Asegúrate de que no te estás perdiendo ningún dato clave. Eliminar cualquier información que no sea relevante para el documento técnico.