Cómo escribir el mejor documento de usuario final

Answer 1

La documentación tradicional realizada para la mayoría de los productos es monótona y agotadora. Los usuarios a menudo se confunden al intentar usar un manual.

Alejándose de la documentación estática, los productos ahora están cambiando a ‘documentación interactiva / guías de usuario’. Estas guías de usuario interactivas dirigen a un usuario a realizar una tarea desde el principio hasta el final.

Whatfix proporciona una manera fácil pero eficiente de crear guías de usuario interactivas sin el uso de ningún conocimiento de codificación.

Permite a los usuarios aprender mientras hacen. Whatfix ayuda a los usuarios a navegar dentro de una aplicación web, capacitándolos y brindándoles soporte contextual proactivo.

Un ejemplo de la documentación en línea del producto podría ser la documentación de ServiceNow creada con la ayuda de Whatfix. El siguiente gif le da una idea general.

Puede enumerar todos los temas de ayuda de su sitio web dentro de un widget de autoayuda. Cada tema de ayuda es una pregunta de “Cómo hacerlo” en sí misma. Cuando un usuario hace clic en un tema de ayuda, comienza un tutorial interactivo. Este tutorial retiene al usuario hasta la finalización de la tarea.

---

Ahora, aquí hay algo aún más interesante.

Cree y exporte instantáneamente múltiples formatos de medios

Los tutoriales interactivos que creamos aquí usando Whatfix es una ventanilla única para todo su contenido interactivo y un excelente complemento para la documentación de su producto.

Una vez creados, los recorridos interactivos se convierten instantáneamente a 5 formatos multimedia:

• Video anotado
• Presentación de diapositivas incrustables
• PDF
• Captura de pantalla
• URL inteligente

Y todo esto se puede integrar rápidamente en cualquier sitio web / aplicación web.

Creación de tutorial rápida, fácil y sin código

Los tutoriales interactivos de Whatfix se pueden crear rápidamente, sin problemas y sin ningún código a través de nuestro editor de apuntar y hacer clic. Un recorrido de 10 pasos generalmente toma menos de 5 minutos para crear.

También puede utilizar los widgets de Whatfix para crear su documentación interactiva del producto.

Orientación interactiva multilingüe segmentada automáticamente

Una vez creados, los tutoriales se pueden convertir a más de 50 idiomas.

La segmentación automática de Whatfix es otra característica que le permite segmentar sus recorridos en función de reglas específicas, roles de usuario, páginas, elementos HTML, etc.

Estas características son solo la punta del iceberg.

Más adelante, estos recorridos pueden ser personalizados para usted de acuerdo con su uso, presupuesto y visión del producto.

---

Desea obtener más información sobre los Tutoriales interactivos, aquí hay un Ebook gratuito útil: Guía de 15 minutos para Tutoriales interactivos

Answer 2

Un Acuerdo de licencia de usuario final (EULA), que puede denominarse licencia de software, le otorga al cliente el derecho de usar su software, siempre que cumpla con todos los términos que usted establece en el EULA. El usuario tendrá la opción de aceptar todos los términos haciendo clic expresamente en “aceptar” o simplemente usando la aplicación misma. De lo contrario, pueden negarse a aceptar el acuerdo devolviendo el software (si es físico) o haciendo clic en la opción que dice “No acepto”.

Mientras escribe su EULA, que cubre aplicaciones de software, asegúrese de escribir también los Términos de servicio (ToS) correspondientes. Estos se utilizan para gobernar el comportamiento de un usuario cuando está utilizando su sitio web o aplicación móvil. Estos le permiten restringir o finalizar el acceso de los usuarios si violan los ToS. Si tiene un servicio basado en la web, es vital contar con él para establecer expectativas para los usuarios que ingresan a su sitio.

Al final del día, estos documentos tienen peso legal y requieren un cumplimiento estricto, ya que usted dice que operará en estricto cumplimiento de estos términos. Para obtener el mejor EULA y ToS, necesitará la ayuda de un abogado que conozca los entresijos de estos documentos.

¡Espero que lo hayas encontrado útil! Si está buscando obtener un EULA o ToS asequible creado a pedido, visítenos en LawTrades, donde puede obtener un presupuesto sin compromiso y una garantía de devolución del 100%.

Answer 3

Buena documentación es difícil de escribir. Hay una serie de formas en las que los documentos técnicos pueden tomar: vistas generales muy generales o de alto nivel, tutoriales paso a paso o documentos autogenerados, por ejemplo. Agregue esto a la variedad de usuarios que podrían necesitar su documentación (sus diferentes necesidades, experiencia técnica, estilos de aprendizaje) y probablemente encontrará que realmente no hay un único formato que funcione para todos.

Escribir para la audiencia correcta

Con eso en mente, lo primero que debe considerar al escribir documentación para su proyecto es la audiencia. Un usuario final querrá documentación que sea principalmente instructiva: un tutorial. Si bien se pueden mencionar (y explicar) algunos conceptos técnicos, el énfasis debe estar en la interfaz, no en el back-end. Otro programador que busque en la documentación querrá información adicional: detalles técnicos de cómo funcionan los elementos del programa, dónde ocurren las acciones del código y, si corresponde, cómo extender el código. Escribir para una audiencia no debe impedir escribir para la otra, pero debe considerar documentos separados: la documentación técnica del usuario y la documentación técnica del técnico, por así decirlo.