La documentación técnica

I. Introducción.

La documentación técnica es una información de calidad le diferenciará de sus competidores Con una información adecuada será más fácil utilizar sus productos y la experiencia resultará más satisfactoria para sus clientes. Sus productos transmitirán una sensación de profesionalidad que será muy apreciada y potenciará las ventas. El coste de los servicios de soporte se reducirá drásticamente si la información del producto incluye las respuestas a las preguntas más habituales a continuacion de daran a conocer algunos de los documentos tecnicos mas habituales, sus usos y sus principales caracteristicas:

Tipos de documentos

En general, se pueden clasificar los documentos técnicos en seis tipos, de acuerdo con su objetivo primordial:

* Manual de usuario

* Guía de usuario

* Tutorial

* Diagrama

* Instructivo

* Planos

* Ficha técnica

* Esquemas

* Guía de instalación

* Documentos en línea

* Documentos en red

* Manual de datos

Desarrollo:

Iniciaremos a describir el concepto y las principales caracteristicas de cada uno de los documentos tecnicos presentados a continuacion.

Manual de usuario

Definición: El manual de usuario es un documento técnico de un determinado sistema que intenta dar asistencia que sus usuarios, en si este se encarga en resolver problemas y de hacer saber al usuario como usar las funciones principales del sistema. Un manual de usuario debe de ser entendido por cualquier tipo de persona ya sea en un principiante como un avanzado

Características del manual de usuario

* Debe contar con información de cómo utilizar el manual

* Un índice.

* Una indicación de cómo utilizar el sistema

* Una sección para la resolución de problemas que no entienda el usuario.

* Una FAQ.

* Información de contacto en caso de fallo.

* Un glosario.

Cuando se usa el manual de usuario: el manual de usuario se utiliza cuando no se sabe nada acerca del producto ni como se utiliza o de cómo armarlo o en caso de computadoras el instalarlo, y así llevar el control del aparato o programa etc.

Guía de usuario

Definición: Un guía de usuario, Es un documento de comunicación que su objetivo es dar una asistencia adecuada a las personas que utilizan algún sistema o aparato de su elección, dichas guías están escritas por ciertos programadores certificados o que conocen del producto, o de los directores de proyectos.

Características de la guía de usuario: Los Guías del usuario se utilizan principalmente con los productos electrónicos, computadoras y programas. La mayoría de las guías de usuario que se elaboran de deben de contener una guía escrita sobre el producto e imágenes que estén relacionadas con el tema para que el usuario entienda mejor lo que se le esta dando a conocer . En el caso de las aplicaciones informáticas, es habitual incluir imágenes de cómo debe de ser el programa y segmentos de cómo se ejecuta y manuales que a frecuentemente incluyen diagramas claramente detallados cortos y muy precisos .El lenguaje utilizado esta sencillo, dirigido a un publico que puede no entender la rama de donde se elaboro el producto.

Cuando se utiliza la guía de usuario: es parecido al manual se utiliza cuando se tiene una duda acerca del funcionamiento del equipo y esta te lleva paso a paso a resolverlo solo que a diferencia del manual de usuario esta utiliza esquemas para entender mas rápido el problema que quieras resolver

Tutorial

Definición: Es un pequeño programa de enseñanza, que te lleva paso a paso y casi de la mano por lo que básicamente debes saber sobre un tema, un programa o un juego ya sea su funcionamiento o su instalación.

Características del tutorial:

* Debe de llevar un orden lógico de pasos

* Deben de ser claro al momento de dar los pasos a seguir

* Debe de tener un titulo y una descripción

* Debe de contar con observaciones o aclaraciones de lo que se esta escribiendo

* En caso de ser para computadora debe de contar con videos y si es a mano debe de llevar diagramas fluidos y precisos

* Debe de contar con números en los pasos a seguir

* Imágenes que estén relacionadas con el tema

* Debe de usar ejemplos y comparaciones para que se entienda mejor

Cuando se utiliza el tutorial

Se utiliza cuando no sabes nada del aparato o programa y no sabes nada sobre la rama que se utilizo para realizarlo y también se utiliza cuando se quiere resolver un problema relacionado con el aparato

Diagramas

Definición Un diagrama o gráfico es un tipo de esquema de información que representa datos o valores, u otra definición es un diagrama es un gráfico que presenta en forma esquematizada información relativa e inherente a algún tipo de ámbito, como ser la política o la economía de alguna nación o empresa y que aparecerá representada numéricamente y en formato tabulado.

Características de los diagramas: hay pocas características en los diagramas solo deben de ser ordenados. Precisos, deben de concordar con el tema, no deben excluir partes importantes del tema, tienen que ser legibles a cualquier persona además tienen que llevar un orden lógico y cronológico.

Tipos de diagramas: Los diagramas se utilizan generalmente para facilitar el entendimiento de largas cantidades de datos y la relación entre diferentes partes de los datos.-Son:

Diagrama de Gantt: es una popular herramienta gráfica cuyo objetivo es el de mostrar el tiempo de dedicación previsto para diferentes tareas o actividades a lo largo de un tiempo total determinado.

Diagrama de Venn: son ilustraciones usadas en la rama de las matemáticas conocida como teoría de conjuntos. Estos diagramas se usan para mostrar gráficamente la relación matemática o lógica entre diferentes grupos de cosas (conjuntos), representando cada conjunto mediante un óvalo o círculo. La forma en que esos círculos se sobreponen entre sí muestra todas las posibles relaciones lógicas entre los conjuntos que representan. Por ejemplo, cuando los círculos se superponen, indican la existencia de subconjuntos con algunas características comunes.

Diagrama de bloques en Sistemas de control: es la representación gráfica de las funciones que lleva a cabo cada componente y el flujo de señales donde cada función de transferencia tiene un bloque asignado y éstos se unen por flechas que representan el flujo de señales.

Se muestran las relaciones

...