Cada vez tengo que escribir más guías de usuario como parte de mi trabajo y necesito rutas para convertir esto en un ejercicio más interesante.
Por lo tanto, en realidad estaba buscando algo completamente diferente cuando comencé a escribir esta pregunta como '¿puedo usar el humor en la escritura técnica?' pero descubrió que esto ya se había preguntado ( ¿Cuánto humor es efectivo en la documentación técnica? ) y la respuesta fue un rotundo no (aparte de los libros X para Dummies).
Entonces estaba pensando en hacer una pregunta como "¿Puedo hacer que las guías de usuario sean más atractivas ?". Fui golpeado por esta interesante pregunta: ¿Puede la escritura técnica apestar menos ? Las respuestas esta vez fueron del tipo 'sí, pero no con humor'.
Y luego vi esto (de Michael ):
Un ejemplo que me vino a la mente son las instrucciones o "reglas" de los juegos. Algunos de estos libros pueden ser tan atractivos que muchos fanáticos solo leen los libros de reglas sin jugar los juegos (sé que lo he hecho, y noto que las personas en los foros de discusión, por ejemplo, los juegos de rol, informan la misma fascinación).
Y esto me llevó a preguntarme acerca de cómo escribir libros de reglas que sean tan entretenidos que se puedan leer de la misma manera que se leen las historias. Entonces, aquí (finalmente) está mi pregunta: ¿Qué tan desafiante sería reescribir un Manual de usuario (aleatorio) como una historia de hazañas e intriga? En otras palabras, ¿cuál sería el mejor enfoque técnico para reescribir una Guía del usuario como una Historia?
Sí, es demasiado amplio, ¿no? Específicamente, entonces, ¿cómo puedo envolver una trama alrededor de algo que no tiene trama? ¿O insertar personajes en algo que no tiene tales bestias? Mmm.
Supongo que mi pregunta se reduce a esto: '¿cuál es la diferencia entre 'escritura técnica' y 'escritura creativa' y cómo puedo cerrar esa brecha, en términos de convertir uno en el otro?
(Publica una pregunta y luego pasa a Warhammer para ver cómo lo hacen allí).
Como se indica en esta respuesta , debe tener en cuenta que, para una guía de usuario, el objetivo de su lector es la información , mientras que para un libro de reglas también puede ser entretenimiento . Si el entretenimiento se interpone en el camino de la información, el lector que tiene que terminar su tarea hoy y no sabe cómo hacer el próximo paso se sentirá frustrado. Hay espacio para el entretenimiento (incluido el humor) en la escritura técnica, pero no debe estar en la ruta crítica .
Una técnica que he visto es usar ejemplos de "barra lateral" con un hilo común. Digo "barra lateral" porque están visiblemente desplazados en su diseño (como en los cuadros), un estilo que también se usa para las reglas del juego. También, al igual que con las reglas del juego, estableces el escenario y luego lo desarrollas progresivamente a lo largo del libro. El cuerpo principal del texto nunca debe dependeren estos ejemplos, porque hay un contexto en esa configuración anterior que sería demasiado trabajo para alguien que solo está tratando de configurar su frobbitz y necesita entender el parámetro cosita, pero el ejemplo está ahí para alguien que (cuando no está presionado por el tiempo) quiere para ver un escenario completo. Un corolario es que estos ejemplos de "barra lateral" no deberían ser los únicos ejemplos en su guía de usuario; muestre ejemplos esenciales "en línea" como lo haría normalmente. Los ejemplos "en línea" demuestran la función particular con tanto detalle como sea necesario; los ejemplos de la "barra lateral" muestran una forma en que todas estas piezas encajan.
Estás haciendo referencia a libros de reglas para juegos de rol, así que basaré mi respuesta en esos como ejemplos, porque conozco la fascinación de leer esos libros sin jugar los juegos correspondientes.
Hay algunas razones que hacen que los libros de reglas sean interesantes para mí:
Puede aplicar esto en ciertas variaciones a las guías de usuario. Simplemente reemplace "Obra de arte" con "Diagrama". Asegúrese de que se ajuste al tema actual y que no solo distraiga sin sentido. Los ejemplos no deben estar en la forma narrativa que ve en los libros de reglas, pero puede usar capturas de pantalla para mostrar cómo alguien debe navegar por el software. La estructura debe ser la misma que la de otros documentos en los que está trabajando para que sea más fácil encontrar las partes relevantes una vez que se acostumbre.
El principal problema es que demasiada creatividad distrae del componente central: la gente quiere información. Y quieren esa información ahora , porque cada minuto perdido podría costar una pequeña fortuna.
Las personas que leen libros de reglas rara vez se encuentran bajo ese tipo de presión al leer los libros. Durante una sesión, rara vez, o mejor nunca, debe buscar algo porque distrae de lo principal, el juego. Es por eso que normalmente tienes todo el tiempo que necesitas para leer un libro así.
Puede aplicar ciertas cosas, desde la escritura creativa hasta la escritura técnica. Pero tiene que tener sentido y adaptarse al estilo general que la gente espera. Incluso si es aburrido, no se le paga para que se divierta creando guías de usuario: se le paga para crear guías de usuario que ayudarán a los usuarios a acostumbrarse al software o encontrar configuraciones importantes cuando están bajo presión. La claridad es más importante en tales circunstancias que la creatividad.
Podría introducir caracteres para usar esos caracteres en ejemplos. Mire a Alice, Bob, Eve y Mallory para ver cómo hacer esto. O si va en una dirección X para Dummies , es posible que desee ver cosas como The Manga Guide to Statistics . Pero estos son más para un público objetivo diferente que su guía de usuario promedio.
celtschk
robertcday