Antes de crear una buena guía de documentación de productos, siempre es mejor ver algunas inspiraciones. He enumerado algunos de los mejores manuales de usuarios y ejemplos de guías de productos en este artículo para inspirarlo lo suficiente como para comenzar a hacer el suyo. Muchos de estos ejemplos son de sitios de productos populares y puede pensar que construir dicha documentación será una tarea costosa y lenta, pero lea hasta el final, ya que he enumerado algunas formas simples de generar documentación similar.
Stripe es una de las conocidas pasarelas de pago utilizada por muchos comerciantes. Permite a las personas y las empresas aceptar el pago fácilmente a través de Internet. He pasado por la documentación ofrecida por ellos y debo decir que la forma en que estaba representada estaba en una limpieza y fácil de entender por los visitantes. La documentación de la API que ofreció ellos fue realmente sorprendente. Se utilizó un marcador de sintaxis que se usó, que permitía mostrar el código fuente en diferentes colores y fuentes.
Hacia la izquierda había diferentes temas que fueron enumerados por él. Si planea construir un sitio web relacionado con API o dónde el código fuente es mucha importancia que definitivamente debe visitar la documentación que ofrece Stripe. La forma en que se representaba la documentación era encomiable. Hubo diferentes temas o las categorías que se enumeraron hacia la izquierda, lo cual es llamativo para los visitantes.
MailChimp es un proveedor de servicios de correo electrónico que le permite crear, enviar y administrar boletines de correo electrónico. La documentación proporcionada por ellos es muy llamativa. Permite agregar los enlaces para la documentación junto con el marcador de sintaxis. Hacia la izquierda hay diferentes secciones que se muestran para la guía y hay una URL diferente para cada una de la sección. La documentación proporcionada por MailChimp se muestra de manera muy atractiva, también todos los puntos e instrucciones se mencionan muy claramente.
¿Cómo se realiza un manual ejemplos?
Sobre todo, hemos aprendido que el acto de traducir un manual representa un examen importante que le permite medir su efectividad, claridad, consistencia (como cuando se da cuenta de que el índice y la estructura de los párrafos no coinciden). Traducir un manual de instrucciones muy a menudo implica un trabajo de reescritura del original, que se traduce en una mejora en la estructura, el contenido y la forma.
En la práctica: para escribir un buen manual, sería apropiado traducirlo, independientemente, e incluso antes de emitir la versión «original».
Algunas palabras más en las instrucciones de uso y mantenimiento de máquinas de uso profesional pueden contribuir a la seguridad, a un mejor uso y reducir los malentendidos entre el cliente y el proveedor. Tanto por el fabricante como por el cliente, una mayor atención a este documento puede ayudar a reconsiderar el área real de sus responsabilidades. En la redacción de las instrucciones, de hecho, el mero respeto de la ley constituye el requisito previo necesario y suficiente para obtener un buen resultado de la comunicación entre el fabricante y el cliente. Para elaborar un excelente documento, es necesario abandonar la idea de que es un documento meramente técnico y ciertamente considerarlo condicionado por las reglas de la ley, pero también destinada a transmitir transparencia al cliente las posibilidades ofrecidas por su propia máquina.
Las instrucciones a menudo carecen de contenido y lenguaje La guía para la redacción del manual de instrucciones y el uso de una máquina es la lista ahora famosa proporcionada por el Anexo I, punto 1.7 de la Directiva de maquinaria, que primero ha establecido la obligación. La información sobre la máquina que la prerrogativa de satisfacer las solicitudes del estándar no debe descuidar la satisfacción de cada una de las solicitudes de información proporcionadas como obligatorias. El personal editorial, la presentación, el tipo de lenguaje utilizado en las instrucciones son gratuitos. Esta libertad no es absoluta: el contenido de la información debe ser fácilmente comprensible para el lector, que con frecuencia no tiene la misma formación que el editor de las instrucciones, y no debe estar incompleta. La dificultad objetivo de comprender la información debe considerarse un defecto de la misma, lo que se traduce en una responsabilidad del fabricante hacia el cliente sobre las consecuencias que puede tener durante el uso de la máquina. Las instrucciones de las máquinas profesionales carecen con frecuencia desde el punto de vista del contenido proporcionado por la ley, usan un lenguaje que abuse de los términos técnicos que no siempre forman parte del patrimonio del conocimiento de todos, no se elaboran de acuerdo con los patrones , no siga una exposición lógica clara, al hacer que la búsqueda de información por parte del usuario sea más compleja, descuidan la contribución de la comunicación que puede derivarse de un buen gráfico y, a menudo, confundir las responsabilidades del fabricante con las del usuario, haciéndolos inhabitable en comparación con los demás. Y finalmente, el defecto más grave: el fabricante apenas logra leer las instrucciones que se han elaborado en una clave crítica y considerar el punto de vista de aquellos que, con esas instrucciones, deben hacer que la máquina funcione. Es poco probable que el fabricante se pregunta qué puede hacer para que las instrucciones sean más comprensibles, en funcionamiento y, como consecuencia de las preguntas que recibe del cliente. La actividad que precede a la conclusión de la venta y, por lo tanto, la instalación de máquinas complejas, que consiste en investigaciones destinadas a comprender las necesidades del cliente, desde los controles en el lugar de instalación, desde el intercambio de piezas de diseño de la máquina, desde la preparación del personal en Cargo sobre la operación de la máquina, no siempre encuentra su propia ubicación apropiada dentro de las instrucciones, a pesar de referirse a las prescripciones del punto mencionado anteriormente 1.7. Desafortunadamente, es difícil encontrar una buena redacción de las instrucciones de uso y mantenimiento de una máquina. Por otro lado, las solicitudes para integrar el contenido de las instrucciones que los clientes a menudo avanzan y que tienen como objetivo limitar sus responsabilidades sobre el uso de la máquina no contribuyen a la mejora de estos documentos.
¿Como debe ser un manual?
[Se ha lanzado una antología manual de la literatura durante el período de tres años de superiores, que escribí y coordiné. Se llama corazones inteligentes. Mil años de literatura (Escuela Garzanti). El Sol 24 me pidió tres carpetas para explicar cómo debería ser una antología manual hoy, y escribí lo que sigue, haciendo prácticamente la identificación mía]
«Todo con suerte. Tuve dos grandes regalos en mis comienzos: trabajar con otros y un abuelo ciego que me obligó a leer lo que había leído cuando era joven. Es decir, las obras maestras de la literatura francesa. A menudo no entendía y arreglaba frente a este extraño ‘jonrón’. Pero me sirvió. Aprendí a amar los libros ».
Entonces, Ettore Scola fue educado, nacido en 1931: son algunas líneas de su última entrevista, otorgadas a Antonio Gnoli di Repubblica. Es difícil decir mejor cuál es uno de los principales objetivos de la educación: transmitir el amor por los libros, libros de todo tipo, para que este amor brote las inteligencias y la sensibilidad como las de Ettore Scola. ¿No querríamos que el futuro esté lleno de personas como esta?
Ahora, una de las buenas ideas de la segunda mitad del siglo XX es que el amor por los libros no debe transmitirse solo a los pocos predestinados que, como Scola, tienen un abuelo que lee esos libros, sino a todos, porque todos lo han hecho. El derecho a ponerse en contacto, durante algunos años de su existencia, con nociones, ideas, imágenes, palabras que no tienen un propósito práctico, como el cultivo de los campos o la gimnasia, pero eso, nos lo dijimos, y nosotros nosotros Todavía lo creas: sirven para vivir la vida de manera más consciente.
Artículos Relacionados:
