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 de escribir sobre algo que usted sabe íntimamente, debe investigar el tema. La recopilación de datos - aprendiendo todo lo que pueda sobre el producto o servicio - es el alma del proyecto.

La investigación interna

Si su investigación es interna, recopilar su información entrevistando a las PYME (expertos en la materia) y otras personas involucradas en el proyecto, la observación de la gente en y alrededor del lugar de trabajo, la lectura de las hojas de especificaciones y literatura de la compañía, y justo a husmear. Estos son algunos consejos para mantener la nariz a la muela sin que se cortó:

• Conozca el producto o servicio íntimamente.

• Prueba de ello. Úsalo. Abrazarlo. Aprenda todo lo que pueda.

• Estudio especificaciones del sistema y dibujos de ingeniería.

• Entrevista al SME. Traiga 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.

• Aprenda las siglas.

• Familiarizarse con las características buenas y malas del producto o servicio.

• Aprenda sobre los posibles defectos con el producto, tales como qué características pueden romper, mal funcionamiento o causar problemas.

• Acogedora hasta los departamentos de marketing y ventas.

• Conozca las ventajas y desventajas del producto o servicio.

• Comprender las características y beneficios que necesita para destacar.

• Sepa cómo se distribuirá el manual y actualizada.

• Averigüe si hay publicaciones o manuales relacionados.

• Averigüe si usted necesita para preparar instrucciones de desembalaje o unas listas de piezas.

• Pregunta lo que hay en la caja de envío.

• Pregunte si el usuario necesita instrucciones para instalar o montar el elemento.

• Recopilar 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 texto estándar que proyectos similares utilizados.

Es importante que usted no solamente confiar en su memoria. Tome abundantes notas al hacer su investigación.

Investigación externa

Usted hace la investigación externa entrevistando a la gente 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:

• Entrevistar 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 usted necesita para obtener información de un montón de gente, usted puede encontrar un cuestionario apropiado. Si tiene que encontrarse cara a cara con una o más personas, siga estas pautas:

• Prepare una lista de objetivos y preguntas de antemano.

• 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.

• Haz una 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:

• Catálogo de tarjetas: Catálogos de tarjetas están dispuestos alfabéticamente por autor, título, y están sujetas a reflejar todos los libros y recursos de la biblioteca posee.

• Bibliografías e índices periódicas: Bibliografías lista de revistas, libros y otras investigaciones publicadas en una amplia variedad de temas. Índices periódicas lista de revistas, periódicos y artículos de prensa. Bibliotecas veces bibliografías casa y periódicos en una habitación separada. Índices más nuevos pueden estar en la plataforma, mientras que los índices de mayor edad pueden estar en otra parte de la biblioteca o en microformas.

• Obras de referencia: Estos incluyen enciclopedias, diccionarios, manuales, manuales, fuentes estadísticas, atlas, y mucho más.

• Navegar por internet. Si usted no sabe la dirección URL del sitio que desea, acceder a uno de los motores de búsqueda populares. Los siguientes son algunos puntos destacados:

• Escriba una palabra clave o frase. El motor de búsqueda busca 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, qué tan temprano aparece la palabra clave 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 usted busca para el perro, se obtiene sitios Web para más perros de lo que 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 sólo la variedad de juguetes.