Paso 1: Planificar el documento
Lo primero que debe hacer con cualquier documento escrito es planificar el material que debe incluirse. Aunque nada en el plan original se acostumbra, es importante empezar a pensar sobre el documento conjunto antes de trabajar en piezas individuales. Es muy útil para echar un vistazo en otras descripciones técnicas para conseguir un asimiento en la "sensación" de cómo se ve una adecuada.
- Al elaborar un plan para su descripción técnica, haga las siguientes preguntas:
- ¿Que va a utilizar este documento?
- ¿Qué tendrá que ser incluida en este documento?
- ¿Cuando la voluntad esta necesidad de documento para ser utilizado?
- ¿A dónde llegará este documento?
- ¿Por qué es necesario este documento?
2. segmentar el tema en varios bloques lógicos. Los ejemplos incluyen:
- Piezas - dividir el tema en sus diferentes partes o características es la manera más directa y puede ser muy lógico para el lector.
- Pasos - si una cosa tiene que pasar por el proceso a seguir, pasos sería la forma ideal para separar la descripción.
- Nota: Si el propósito de este documento es enseñar al lector cómo hacer un proceso, no puede ser una descripción técnica pero las instrucciones!
3. plan de los gráficos o logos que tendrán que utilizarse.
- Tablas, cuadros y gráficos son género definiendo características de descripciones técnicas. Se utilizan para romper para arriba el texto y dar información importante al lector.
- Un buen gráfico puede valerse por sí mismo y contar una historia completa. El objetivo debe ser para que el lector que no es necesario escanear a través de los apartados del gráfico a ser relevantes.
- PRECAUCIÓN: Si esta descripción técnica se utilizará en un entorno comercial, asegúrese de solo incluir gráficos que la empresa tiene el derecho legal de!
