Conseguir que sus brazos alrededor de un documento técnico
El propósito de escribir un documento técnico es explicar o informar sobre un tema técnico o complejo. Por lo tanto, a menos que usted es el gurú técnico escribir sobre algo que conoces íntimamente, debe investigar el tema. La recolección de datos - aprendiendo todo lo posible sobre el producto o servicio - es el elemento vital del proyecto.
la investigación interna
Si su investigación es interna, recopilar su información a través de entrevistas PYME (expertos en la materia) y otras personas involucradas en el proyecto, observando a la gente en y alrededor del lugar de trabajo, la lectura de las hojas de especificaciones e información de la compañía, y justo a husmear. Estos son algunos consejos para mantener su nariz a la muela sin que se cortó:
- Llegar a conocer el producto o servicio íntimamente.
• Pruébalo. Usarlo. Abrazarlo. Aprenda todo lo que pueda.
• Estudio de las especificaciones del sistema y dibujos de ingeniería.
• Entrevista al SME. Lleve una lista de preguntas que preparó.
- Absorbe el cuadro grande.
• Averigüe acerca de la finalidad del producto o servicio, que va a usarlo, por qué, y cuándo.
• Aprender las siglas.
• Familiarizarse con las características buenas y malas del producto o servicio.
Video: ¿En qué consiste la gestión documental?
• Aprender acerca de los posibles defectos con el producto, tales como qué características pueden romper, mal funcionamiento o causar problemas.
- Adular a los departamentos de marketing y ventas.
• Conocer las ventajas y desventajas del producto o servicio.
• Comprender las características y beneficios que necesita para destacar.
• Conocer cómo se distribuirá el manual y actualizado.
• Averigüe si hay publicaciones o manuales relacionados.
- Averigüe si usted necesita para preparar instrucciones de desembalaje o unas listas de piezas.
• Haz lo que hay en la caja de embalaje.
• Pregunte si el usuario necesita instrucciones para instalar o montar el elemento.
- Recoger datos tanto escritos o gráficos que pueda. Siempre se puede descartar lo que no es necesario.
• Decidir qué fotos o gráficos que necesita.
• Obtener copias de un manual de estilo o de texto estándar que utilizan proyectos similares.
Es importante que no se limitan a confiar en su memoria. Tomar notas copiosas mientras que hace su investigación.
investigación externa
Hacer una investigación externa, entrevistando a las personas fuera de su organización, visitando la biblioteca, o navegar por la web. He aquí algunos consejos para hacer su trabajo más fácil:
- Entrevista a personas fuera de su empresa. Usted puede visitar a la gente personalmente o enviar un cuestionario. ¿Qué hacer, por supuesto, depende de la naturaleza de su investigación. Si es necesario recopilar información de una gran cantidad de personas, es posible un cuestionario es apropiado. Si tiene que encontrarse cara a cara con uno o más personas, siga estas pautas:
• Prepare una lista de objetivos y preguntas de antemano.
• Deje que el entrevistado haga la mayor parte de la conversación. Después de todo, usted está allí para aprender.
• Coge toda la literatura que el entrevistado está dispuesto a compartir.
• Tome notas copiosas o usar una grabadora, si es apropiado.
- Hacer investigación en la biblioteca. Hay una variedad de maneras de utilizar la biblioteca para la investigación. Si necesita ayuda para utilizar cualquiera de los siguientes servicios de biblioteca, pida al bibliotecario:
• Catalogo de cartas: Los catálogos de fichas están ordenadas alfabéticamente por autor, título y materia para reflejar todos los libros y recursos de la biblioteca propietaria.
• Bibliografías e índices periódicas: Bibliografías lista de revistas, libros y otras investigaciones publicadas en una amplia variedad de áreas temáticas. Lista de índices de publicaciones periódicas, revistas, periódicos y artículos de prensa. Bibliotecas veces bibliografías de las casas y periódicos en una habitación separada. los índices más nuevos pueden estar en la biblioteca, mientras que los índices de mayor edad pueden estar en otra parte de la biblioteca o en microformato.
Video: Documento Técnico 1 2
• Obras de referencia: Estos incluyen enciclopedias, diccionarios, manuales, manuales, fuentes estadísticas, atlas y más.
- Navegar por la web. Si no conoce la dirección URL del sitio que desea, acceder a uno de los motores de búsqueda populares. Los siguientes son algunos puntos destacados:
• Escribir una palabra clave o frase. El motor de búsqueda es de documentos que tienen su palabra clave (s). A continuación, clasifica los sitios basados en cuántas veces aparece la palabra clave en el documento, si la palabra clave aparece en el título, la antelación con la palabra clave aparece en el texto, y así sucesivamente.
• Trate de que su búsqueda sea lo más estrecha posible. De lo contrario, puede obtener miles de visitas. Por ejemplo, si se busca para el perro, se obtiene sitios Web para más perros que usted quiere ladrar a usted. Si busca caniche, usted consigue todos los tipos de caniches. Si busca caniche de juguete, a limitar la búsqueda a la variedad de juguetes solamente.