Consejos sobre la creación de documentación Formación Técnica Buena

El usuario final es el público al que va a crear la documentación técnica. Es fundamental comprender la audiencia correctamente antes de empezar a escribir. Considere sus necesidades, nivel de habilidad y capacidad de entender los puntos que abordar. Cualquier documentación técnica que no cubre la información requerida o es demasiado difícil de entender es insuficiente.

Video: Fichas de Trabajo

Antes de empezar a escribir, hay que entender el producto o herramienta que va a escribir sobre. El proceso de investigación por lo general involucra entrevistar a expertos en la materia que tienen un conocimiento profundo sobre el producto. El experto en la materia podría ser un ingeniero o desarrollador que fue parte del equipo que desarrolló el producto. También puede probar el producto o el software usted mismo.

Video: Exclusivo: Dentro del Laboratorio de Fertilizacion In Vitro (IVF)

Es importante tomar nota de todas las piezas relevantes de información, especialmente de datos altamente técnico que puede ser difícil de recordar en una fecha posterior. Organizar la información y crear una tabla de contenido. Verificar la tabla de contenido con un experto en la materia y empezar a trabajar en el primer borrador.

Como se ensamblan la información, debe seguir la guía de estilo requerido también. Utilice la voz activa y evitar la jerga innecesaria. documentación de la formación técnica debe ser claro y conciso. Añadir imágenes, concursos y consejos a intervalos regulares. Esto evitará que el lector ocupado y también simplificar el proceso de aprendizaje. Si la documentación incluye cómo-a los procedimientos o pasos, debe realizar los procedimientos a sí mismo e incluir capturas de pantalla o imágenes cuando sea necesario. procedimientos de actualización cada vez que el producto de software o cambios.

Video: Cómo hacer un buen trabajo de investigación (o un proyecto) en 10 pasos.wmv

Sobre una base regular, se reúnen con el experto en la materia y su editor (si lo tiene). Haga que revisar el contenido o capítulos que haya creado. Incorporar sus comentarios y también tenerlo en cuenta para el contenido que se está trabajando. Este proceso reducirá en gran medida la carga de trabajo hacia el final del proyecto.

Después de haber creado un anteproyecto, se puede presentar a su gerente, director, experto en la materia y también algunos desarrolladores que pueden darle más comentarios. Obtener la opinión de todo el mundo e incorporar los cambios necesarios. Guarde una copia de cada proyecto para que pueda volver atrás y recuperar la información borrada si es necesario. Póngase en los zapatos del lector y pasar por la documentación y formular las siguientes preguntas: ¿Usted entiende los conceptos básicos? ¿La información del progreso de una manera lógica? ¿El interés de contenido y educativa para usted? Si la respuesta a estas preguntas es sí, usted ha tenido éxito en su objetivo.