Documentación técnica

NTRODUCCION

Se habla de la planeación de documentos y explicaremos con detalle las etapas a realizar para llevar acabo dicho documento, se debe cumplir cada una de las etapas en orden para así realizar un documento de calidad, y sea fácil de leer para el lector.

PLANEACION DE LOS DOCUMENTOS

Al momento de realizar un documento técnico tenemos que tomar en cuenta a toda la serie de problemas a los que nos podemos enfrentar:

• Al momento de estructurar un documento

• Al momento de decidir el formato y las medidas que llevará

• Qué contenidos tendrá el documento.

• Deberá ser fácil de leer.

• Y sobre todo la edición y el modo de difusión.

DISEÑO

Esta es la segunda etapa de la planeación de documentos en la cual se tiene que elegir diseño del formato, cuidar el lenguaje con el que se realiza dependiendo de los lectores a quien va dirigido dicho documento.

Durante el diseño se tiene que realizar las siguientes actividades:

Definir las especificaciones de contenido.

• Desarrollar la estructura detallada de los documentos.

• Establecer los componentes de la guía de estilos.

• Diseñar documentos prototipo.

• Revisar el plan de trabajo.

A partir del diseño se generan tres productos:

• Estructura detallada de los documentos.

• Borrador de la guía de estilos.

• Reporte de avance.

DESARROLLO

Este es el tercer paso a seguir donde se realiza el desarrollo del contenido.

• Crear documentos prototipo.

• Obtener la aprobación de los prototipos.

• Completar la guía de estilos.

• Crear las ilustraciones.

• Crear y revisar borradores.

A partir del desarrollo se generan tres productos:

• Documentos prototipo

• Guía de estilos

• Reporte de avance

EVALUACION

Este se encarga de la revisión y verificación del contenido una vez realizadas las etapas donde se también se verifica que el documento cumpla con todos los estándares los cuales son verificados por personas ajenas a los esc

...