En esta página, se incluyen los detalles de un proyecto de redacción técnica aceptado para la temporada de Documentos de Google.
Resumen del proyecto
- Organización de código abierto:
- WordPress
- Escritor técnico:
- dmivelli
- Nombre del proyecto:
- Mejora la visibilidad de los artículos en la documentación de HelpHub de WordPress
- Duración del proyecto:
- Duración estándar (3 meses)
Project description
Resumen ejecutivo
La popularidad de WordPress crece minuto a minuto. Desde principios de julio de 2020, WordPress 5.4 (la versión más reciente lanzada el 21 de marzo de 2020) se descargó casi 51 millones de veces. El idioma más utilizado es el inglés (71%), seguido del español (4.7%) y el indonesio (2.4%).
La excelente documentación técnica es la base de cualquier sistema de ayuda. Los escritores técnicos experimentados convierten el conocimiento en contenido para los usuarios. Los usuarios buscan realizar una acción que sea valiosa para ellos o que se les requiera en ese momento. Los buenos escritores técnicos entienden que la documentación precisa y bien escrita, y la capacidad de ponerse en el lugar del usuario son esenciales. Sin embargo, lo que más les importa a un escritor técnico, como la calidad editorial y de producción, pueden ser menos importantes para los usuarios que la puntualidad y la visibilidad. ¿De qué sirve un tema de ayuda bien escrito si el usuario no puede encontrarlo?
Desde sus inicios en 2003, el crecimiento de WordPress en el campo del código abierto atrajo a desarrolladores, usuarios y colaboradores. Las categorías y etiquetas de los artículos originales deben actualizarse y modernizarse para mantenerse al día con el crecimiento y las necesidades cambiantes de la comunidad de WordPress.
Cuando las rutas de los usuarios hacia la documentación solicitada son confusas o se interrumpen, fallan en su búsqueda, pierden confianza en el producto y pueden abandonarlo por completo.
Hay una solución. A continuación, se incluyen algunas formas de mejorar la visibilidad y respaldar la ruta del usuario hacia la documentación esperada:
- Decide y establece el estilo de los títulos de las categorías
- Evalúa los títulos de las categorías y asegúrate de que aborden correctamente los temas (propón actualizaciones, si es necesario).
- Revisa los artículos y asegúrate de que las categorizaciones sean correctas.
- Definir subcategorías para cada artículo
- Garantizar que ningún resultado de la búsqueda guíe a los usuarios a los foros de asistencia
- Anotar temas duplicados o desactualizados para borrarlos
La comunidad de WordPress realizó un trabajo notable y comparte los logros de los últimos 17 años. Actualizar la categorización y garantizar que el recorrido del usuario sea preciso seguirá impulsando el crecimiento, el éxito y la lealtad de los usuarios que crean casi 70 millones de publicaciones nuevas y 77 millones de comentarios nuevos cada mes.
Introducción
El autor Joseph Campbell acuñó el término “viaje del héroe”. En la ficción, se refiere al concepto estructural en el que el protagonista viaja por el mundo, enfrenta y supera desafíos, y regresa transformado.
En el ámbito de la documentación técnica, el usuario también emprende un recorrido que lo lleva a los temas de ayuda con el objetivo de aprender, obtener respuestas y solucionar problemas. Cuando el usuario puede lograr esto, todo está bien en su mundo. Cuando los usuarios no pueden encontrar respuestas, se marchan con frustración y descorazonamiento.
Pero ¿por qué sucede esto? No es porque los escritores tomen atajos, no les importe o no tengan el conocimiento necesario. A menudo, es que el escritor técnico no tuvo en cuenta el recorrido del usuario. Los escritores pueden sumergirse en la creación de buen contenido, pero no tienen en cuenta cómo el usuario accederá al tema. Es fundamental enfocarse en el recorrido del usuario. Debemos considerar qué quieren saber y cómo quieren llegar allí.
Hablé con la consultora de WordPress y diseñadora de UX Estela Rueda, quien me proporcionó algunos antecedentes. Actualmente, algunos títulos no describen correctamente el contenido de los artículos. Las categorías se usan como etiquetas y, debido a que se crearon hace 15 años, algunas están desactualizadas. El etiquetado es incoherente. Esto genera obstáculos para los usuarios que buscan respuestas.
Estado actual
La asistencia de WordPress se divide en nueve categorías principales (Introducción, Cómo instalar WordPress, Uso básico, Administración básica, Personalización, Mantenimiento, Seguridad, Temas avanzados y Solución de problemas). Cada categoría contiene varias subcategorías o subtemas que dirigen a los artículos con la posibilidad de ver más en cada página de destino.
Los beneficios de tener colaboradores entusiastas y colaborativos de WordPress son que hay muchos temas disponibles. Sin embargo, con tantas voces y puntos de vista, las etiquetas y las categorías no son coherentes.
Estos temas deben modernizarse para garantizar que las categorías satisfagan las necesidades actuales de los usuarios de WordPress. Con más de 200 artículos, los problemas con las etiquetas y las categorizaciones se volvieron relevantes.
Análisis del plan
El objetivo principal es revisar y volver a clasificar los artículos para mejorar la capacidad de búsqueda. Propongo los siguientes pasos:
Trabaja con la mentora Estela Rueda para consolidar el proceso
- Este es un paso importante para garantizar que se confirmen y acuerden los detalles.
- Según Estela, haremos un seguimiento de todas las actualizaciones propuestas en una hoja de cálculo (la experiencia de Estela demostró que es mejor recopilar y, luego, proponer recomendaciones).
Decide y establece el estilo de los títulos de las categorías.
- Sugiero una estructura uniforme y consistente para las categorías en el presente en lugar del formato gerundio (Instalación vs. instalación), ya que la forma en gerundio (-ing) puede generar dificultades para los usuarios de inglés como segundo idioma (ESL) y el -ing no agrega valor al usuario.
- Algunas categorías son temas de una o dos palabras (como Mantenimiento, Seguridad, Administración básica) y otras son frases con gerundio (Comenzar a usar WordPress, Personalización). Tiene sentido analizar cómo hacer que la estructura sea coherente.
- Estuve investigando cómo otras organizaciones establecieron su ayuda en línea y analizaré esto con mi mentor para ver qué podría ser útil.
Evalúa los títulos de las categorías (y propone actualizaciones)
- Deben ser reconocibles para la perspectiva del público objetivo de WordPress y adaptarse a sus necesidades actuales.
- Confirma que sean coherentes y cumplan con los estándares del Manual de estilo de WordPress.
- Asegúrate de que los títulos transmitan o expliquen el intent
- Los títulos deben aclarar las acciones de requisito previo o los estados del usuario o del dispositivo necesarios.
Revisa artículos o temas
- ¿Los temas satisfacen con precisión las necesidades de los usuarios del público objetivo de WordPress?
- ¿Los temas establecen el contexto correcto o forman parte de una secuencia más grande?
- ¿Los pasos distinguen a los diversos actores de la tarea (usuario, sistema o dispositivo, quién hace qué)?
- ¿Se distinguen claramente los actores?
- ¿Los pasos dividen los procesos complejos en partes prácticas?
Define y etiqueta subcategorías
- Consulta las historias de usuario y sigue agregando información a la hoja de cálculo para usarla en el futuro.
- Sigue agregando elementos a la lista de subcategorías y detalla su ruta
Asegúrate de que ningún resultado de la búsqueda vincule a los usuarios a los foros de asistencia
Se deben tener en cuenta los temas duplicados u obsoletos para eliminarlos. Este trabajo de investigación forense ayudará a informar y agilizar los recorridos de los usuarios.
Cronograma
Hasta el 16 de agosto de 2020
- Sigue revisando la documentación de WordPress
- Familiarízate con el estilo de la documentación de WordPress
- Investiga las prácticas recomendadas para los recorridos de los clientes en los temas de ayuda
Del 17 de agosto al 13 de septiembre
- Conoce a Estela y trabaja con ella y la comunidad de WordPress
- Colaborar con Estela para refinar los pasos del proyecto y sugerir hitos para su finalización
- Crear un cronograma para incluir hitos y tareas semanales
- Establecer una cadencia para un registro de estado con Estela (para abordar los obstáculos de manera oportuna)
Del 14 de septiembre al 30 de noviembre
- Trabajo inicial y desarrollo del proyecto con Estela/mentores
Del 2 al 5 de diciembre
- Envía el informe final del producto de trabajo
Del 3 al 10 de diciembre
- Enviar una evaluación del éxito del proyecto y de la experiencia de trabajo con el equipo y los mentores de WordPress
Conclusión
WordPress es el sistema de administración de contenido (CMS) más popular. Según W3techs, WordPress es el CMS preferido por el 37.7% de todos los sitios web, lo que le otorga un 63.6% de la participación de mercado de los CMS.
Con este grado de popularidad, la documentación precisa y fácil de seguir es imprescindible para ganarse el corazón del usuario de WordPress.
Si se tiene en cuenta el recorrido del usuario y las preguntas que informan las posibles rutas de los usuarios, WordPress puede modernizar las categorías de ayuda y el etiquetado para responder preguntas y solucionar problemas de manera eficaz. De esta manera, WordPress seguirá atrayendo a clientes satisfechos durante los próximos años.