escritor técnico utilizar el nuevo personaje para crear la parte más útil de su documento de usuario

visión de conjunto

Un buen documento del usuario incluye secciones sobre cómo instalar, usar y cuidar el producto. Sin embargo, para crear un gran documento del usuario, el escritor técnico debe utilizar la Persona, generado en el análisis de la usuario / lector, para crear los temas de la parte más útil del documento del usuario. En este artículo se describe este procedimiento.

la sección más útil de un documento de usuario

La parte más útil de un documento del usuario es la que ayuda al usuario a conseguir lo que él / ella quiere / necesita hacer ahora mismo!

Escribir una sección que podría parecer imposible. ¿Cómo sabes lo que el usuario tiene que hacer ahora?

La única cosa que usted, como escritor, no puede hacer es jugar a las probabilidades. Es decir, determinar los temas que tienen la mayor probabilidad de ser de interés para el usuario. Y “de interés” significa “hacer lo que el usuario quiere que se haga, ahora mismo.”

Creamos Persona (una representación casi real de usuario de su producto) en otro artículo en el “New Technical Writer” de la serie (ver los enlaces en la sección “Recursos” o “Información Autor” de este artículo). Podemos usar la Persona para crear una lista de temas para esta sección.

con su personaje

Este paso en el uso de su Persona es olvidada por casi todos los documentos del usuario que he visto. Sin embargo, este paso dará lugar a un documento del usuario que sea más satisfactorio para su lector. Aquí es:

Imagine su Persona usar su producto. Ahora, ¿cuáles son las principales cosas que tu Persona querrá hacer con su producto.

Como ejemplo vamos a utilizar un programa de edición fotográfica (Acme FotoPhixer, un producto hipotético de una empresa hipotética) que viene incluido con un punto y disparar la cámara digital. Nuestra Persona es un usuario típico de tal cámara.

Pregunte: ¿Qué quiere decir Persona quieren hacer con FotoPhixer Acme?

La respuesta corta es que quieren mejorar sus fotos. ¿Cómo pueden mejorar sus fotos con FotoPhixer Acme? En nuestras palabras (no las palabras del Usuario) podríamos decirles cómo:

* Girar
* Cultivo
* Eliminación de ojos rojos
* Ajuste de brillo y contraste
* Eliminación de elementos no deseados de la foto
* Enfoque / desenfoque
* Ahorra
* Impresión
Share *

Estos nombres son lo que nosotros, los expertos en fotografía podría utilizar. Sin embargo, “cosecha” pueden carecer de sentido a nuestra Persona. De hecho, nos podíamos cambiar de cultivos en “Extracción de elementos no deseados de la foto.”

El “Enfoque / Desenfoque” tema es interesante. Si una foto está fuera de foco o borrosas, no hay realmente nada de lo que nuestro software puede hacer para mejorarlo. Sin embargo, nuestro lector no lo sabe, pero quiere hacerlo. Debemos incluir tema con este texto: “Es imposible fijar el enfoque o eliminar borrando en una fotografía Usted puede ser capaz de mejorar esta usando el botón [Enfocar Efecto] herramienta en FotoPhixer.». (La [] especifica una referencia al tema en el documento del usuario.)

no ocultan esta sección

Si el lector no puede encontrar rápidamente lo que él / ella quiere hacer en su documento del usuario, el documento ha fallado. Desde que creamos esta sección para responder a las urgentes necesidades del usuario para el producto, entonces debemos hacer que esta sección muy accesible para el usuario – que tienen que ser capaces de encontrar fácilmente.

“La fijación (Mejorar) Su imagen” es un perfecto, orientado a los usuarios título. Ese es el título correcto para esta sección. No entierre este oro bajo títulos como: “. Utilizar herramientas FotoPhixer de” “Tutorial” o Estos títulos no sugieren respuestas a las preguntas del usuario.

Usted debe hacer esta sección muy fácil de encontrar en el documento del usuario. Es la sección clave del documento del usuario. Tiene la información que la mayoría de lectores quieren, la mayoría de las veces (por su análisis). Colóquelo en un lugar destacado el documento del usuario.

satisfacer el lector es más fácil de lo que piensas

La producción de esta sección es más fácil de lo que piensas.

En primer lugar, imagine que usted no se va a incluir esta sección. El documento del usuario tendría que cubrir todas las características, herramientas, y las interacciones del usuario del producto. Tienes que hacer que para satisfacer a su jefe. También es lógico. Si una característica no se describe, entonces ¿por qué está en el producto?

Así, se ha creado una lista de temas para un documento “clásico” del usuario.

Ahora vamos a crear nuestro usuario orientada sección, “La fijación de su imagen”. Estos son los pasos:

1. Enumere cada uno de los temas para la fijación de una imagen, usando títulos que el lector pueda entender.
2. Proporcionar una breve descripción, tal vez con una imagen que muestra antes y después de la utilización de este método de fijación.
3. A continuación, una lista de los pasos a seguir para ese tema, y ??proporcionar enlaces a la documentación de las herramientas pertinentes para cada paso

hecho!

En realidad, yo recomiendo usar lo que yo llamo un “Índice Visual”, que se describe en los enlaces de la sección “Recursos” o “Autor de la información” de este artículo.
dentro del documento reutilización

Podríamos llamar a este método de organización “dentro del documento reutilización”. Aquí el escrito de un tema existe como un elemento de la “referencia” del documento del usuario. Al referirse a ese tema cuando sea necesario para llevar a cabo una tarea orientada al usuario, hacemos el texto hacer una doble función. Esto da lugar a la reutilización en el documento.

cómo sacar el tiempo para escribir esta sección

Dicho esfuerzo menos detallado en la documentación de las características del producto que se usan raramente. Por ejemplo, FotoPhixer incluye herramientas para hacer que la imagen se vea como si estuviera hecho de piedra, o producir efectos 3D, etc Estos se usan muy poco, y tienen un conjunto similar de controles. En lugar de detallar el uso de cada una de estas características raramente usadas, escribe un uso global, se describen los controles, fomentar el usuario a experimentar, y recordarles de la no-hacer y cancelar capacidades.

Usted puede crear el “más útil” sección con el tiempo que se ahorra al no documentar a fondo estos temas rara vez utilizados.

la línea de fondo

Usted puede hacer su documento de usuario mucho más eficaz si se piensa en el usuario / lector y lo que él / ella quiere hacer con el producto. Utilice esta información para crear un fácil de encontrar en su sección de documentos del usuario que satisfaga las necesidades de su lector.