Gran escritura técnica: El usuario-ciclo de vida - una herramienta de documentación

escritura, documento de usuario, temas, manual de usuario, cómo escribir






Cuerpo del artículo:


El ciclo de vida del producto de usuario (U-PLC) es una herramienta poderosa para el escritor de documentos del usuario. Utilice el U-PLC para generar los temas de alto nivel para el documento de usuario.




EL PRODUCTO DE USUARIO (U-PLC) DE CICLO DE VIDA




Normalmente, cuando pensamos en un ciclo de vida del producto, pensamos en términos del desarrollo y producción del producto en sí. Al escribir la documentación de usuario, considere la posibilidad de la U-PLC para ayudarle a generar todos los temas necesarios para un documento completo. Documentación de usuario debe apoyar a los usuarios en todas sus interacciones con el producto.




El ciclo de vida del producto del usuario se refiere a la gama completa de las interacciones entre el usuario y el producto en sí. Esto es más que simplemente "cómo utilizar el producto." Como se verá a continuación, "Uso el producto" es sólo una etapa en la U-PLC.




ETAPAS EN LA U-PLC




Aquí están las etapas en la U-PLC (suponiendo que el usuario que adquiere el producto):




-Etapa de LC U-P: transportar el producto a su lugar de trabajo




-Etapa de LC U-P: desempaquetar el producto




Transporte y Unpacking del producto se enumeran aquí sólo para la integridad. Éstos se muestran en el embalaje, generalmente en forma pictórica y hacen un buen trabajo.




-Etapa de LC U-P: conocimientos generales sobre el producto.




Se trata de información que se presenta al usuario a principios de los documentos del usuario.




Aquí los temas incluyen seguridad, legal y avisos relacionados con el producto.




La descripción del producto debe indicar cómo el producto puede cambiar la forma en que el usuario actualmente hace las cosas. Por ejemplo, una grabadora analógica requerirá el usuario escuchar a todos los elementos almacenados para encontrar una particular; una grabadora digital permitirá al usuario saltar rápidamente de un mensaje a otro.




-Etapa de LC U-P: configurar o instalar el producto




* Entornos




Es importante que el escritor a pensar en los diversos ambientes donde existirá el producto. ¿Por ejemplo, cómo debe un programa instalado en un entorno Windows, Mac o Linux?




"Entornos" incluyen otras cosas que el producto debe trabajar con. ¿Por ejemplo, cómo debe un reproductor de DVD instalado en un sistema compuesto actualmente de un televisor y un VCR? ¿Qué tal instalación en un sistema de TV & Video donde la TV tiene sólo una entrada de vídeo?




* El usuario capacidades.




También son importantes las capacidades necesarias para que el usuario configurar el producto. Dado que las hipótesis relacionadas con el usuario para conjunto hasta pueden ser diferentes de las hipótesis sobre el usuario en el uso del producto, el sabio escritor presentará las habilidades (y tal vez reglamentos) necesarios para configurar el producto. Una sección titulada "Puede usted configurar este producto?" que el usuario pueda tomar la decisión sobre si va a establecer el producto por sí mismos o buscar ayuda externa.




Por ejemplo, supongamos que el producto es una tenue luz eléctrica que pretende sustituir el interruptor de luz en casa del usuario. Utilizar el producto simplemente requiere ajustar control único de la etapa para establecer el nivel deseado de luz. Instalar el producto requiere experiencia con casa eléctrica--¿el usuario tiene estas capacidades?




A veces, la limitación puede ser legal. En algunas jurisdicciones, Quebec, Canadá, por ejemplo--sólo electricistas calificados se permiten instalar o modificar los circuitos eléctricos en el hogar. Así, en Quebec, el usuario general de la etapa no será capaz de instalar (legalmente) la tenue luz.




-Etapa de LC U-P: utilizar el producto




Este componente es el foco de más documentación para el usuario. Debe contener al menos estos tres subtemas:




-Desde el producto




-Uso del producto




Para la mayoría de los productos "Uso real" es el eje central del documento de usuario.




Idealmente, esto debe dividido en funciones del producto básico o común y avanzada funciones. Un buen ejemplo es la edición de fotografía software. La mayoría de los usuarios que desee recortar, girar y ajustar el brillo y el contraste de la imagen. Estas son las funciones básicas. Funciones más avanzadas pueden combinar las partes de una imagen con otro.




-Apagar el producto




¿Hay cualquier mantenimiento para hacerse al cierre? Lista aquí y en la sección de "Mantener".




-Etapa de LC U-P: mantener el producto




Considere la posibilidad de romper esta abajo en períodos de tiempo, tales como: después de cada uso, semanal, mensual, anual, según corresponda.




-Etapa de LC U-P: mover el producto




Para un programa de software de computadora, cómo el usuario debe mover el programa y sus datos a otro equipo; los usuarios de computadoras a menudo actualización sus equipos. ¿Mientras que a menudo se asume que el usuario debe volver a instalar el producto en el nuevo equipo, siempre existe la pregunta acerca de cómo mover los datos relacionados con el producto: donde se encuentra, y cómo se debe mover por lo que el programa recién instalado lo puede reconocer en el nuevo equipo?




¿Para un producto físico, son las consideraciones especiales en mover el producto a otra ubicación?




-Etapa de LC U-P: descartar el producto o sus subproductos




Aquí me gustaría mencionar sólo vendiendo el producto utilizado. Sería conveniente mencionar que manteniendo el Manual de usuario, el vendedor puede resultarle más fácil vender y posiblemente obtener un precio más alto, el producto utilizado.




UTILIZANDO EL U-PLC EN SU ESCRITURA




Como generar los temas para el documento de usuario asegurarse de que mantenga el U-PLC en mente. Asegúrese de que incluye temas en su esquema de documento de usuario para ayudar a su usuario en todas las fases de la U-PLC.




Documentos gran usuario puede ayudar en la sección de arriba-LC que no presento aquí: adquisición del producto. Su departamento de marketing puede ser capaz de utilizar su gran documento de usuario como parte de su campaña de marketing.