Esta página contiene 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. A principios de julio de 2020, WordPress 5.4 (la versión más reciente que se lanzó el 21 de marzo de 2020) se descargó casi 51 millones de veces. El idioma más usado es el inglés (71%), seguido del español (4.7) y el indonesio (2.4).
Una excelente documentación técnica es la columna vertebral de cualquier sistema de ayuda. Los escritores técnicos con experiencia crean conocimientos para crear contenido para los usuarios. Los usuarios desean realizar alguna acción que sea valiosa o requerida en ese momento. Los buenos redactores técnicos comprenden que es esencial contar con documentación precisa y bien redactada, y la capacidad de ubicarse en la mente del usuario. Sin embargo, lo que puede ser más importante para un escritor técnico, como la calidad editorial y de producción, puede ser menos importante 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 su comienzo en 2003, el crecimiento de WordPress en el ámbito del código abierto ha atraído a desarrolladores, usuarios y colaboradores. Las categorías y etiquetas de los artículos originales necesitan actualizarse y modernizarse para estar al día con el crecimiento y las necesidades cambiantes de la comunidad de WordPress.
Cuando las rutas de los usuarios a la documentación solicitada son confusas o interrumpidas, fallan en la búsqueda, pierden confianza en el producto y pueden abandonarlo por completo.
Hay una solución. Las siguientes son maneras de mejorar la visibilidad y admitir la ruta de acceso del usuario a la documentación esperada:
- Define 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 los temas de forma correcta (propón actualizaciones, si es necesario).
- Revisa los artículos y asegúrate de que las categorizaciones sean correctas
- Cómo definir subcategorías para cada artículo
- Asegúrate de que ningún resultado de la búsqueda guíe a los usuarios a los foros de asistencia.
- Anota los temas duplicados o desactualizados para borrarlos.
La comunidad de WordPress realizó trabajos extraordinarios y compartió los logros de los últimos 17 años. Para actualizar la categorización y garantizar que el recorrido del usuario sea preciso, seguiremos 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 por mes.
Introducción
El autor Joseph Campbell acuñó el término "el viaje del héroe". En 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 inicia 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 van frustrados y desanimados.
Pero, ¿por qué sucede esto? Esto no se debe a que los escritores son reñidos, no les importa o no tienen los conocimientos técnicos. A menudo, 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 consideran cómo el usuario accederá al tema. Centrarse en el recorrido del usuario es fundamental. Debemos considerar qué quieren saber y cómo quieren lograrlo.
Hablé con Estela Rueda, consultora de WordPress y diseñadora de UX, que me brindó un poco de historia. En la actualidad, algunos títulos no describen correctamente el contenido del artículo. Las categorías se utilizan como etiquetas y, como se crearon hace 15 años, algunas están desactualizadas. El etiquetado es incoherente. Esto crea obstáculos para los usuarios que buscan respuestas.
Estado actual
La asistencia de WordPress se divide en nueve categorías principales: Introducción, Instalación de 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 usuarios a artículos con la posibilidad de aumentarlo en cada página de destino.
El beneficio de tener colaboradores entusiastas y colaborativos de WordPress es que hay muchos temas disponibles. Sin embargo, dado que hay muchas voces y puntos de vista, el etiquetado 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 relacionados 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. Te 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, realizaremos un seguimiento de todas las actualizaciones propuestas en una hoja de cálculo (la experiencia de Estela demostró que lo mejor es recopilarlas y luego proponer recomendaciones).
Define y establece el estilo de los títulos de las categorías
- Sugiero una estructura uniforme y coherente para las categorías en tiempo presente en lugar de la forma de gerundio (Instalar versus instalar), ya que la forma de gerundio (-ing) puede crear 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 y dos palabras (como Mantenimiento, Seguridad, Administración básica) y otras son frases de Gerundio (Introducción a WordPress, Personalización). Vale la pena analizar para lograr que la estructura sea coherente.
- Investigué cómo otras organizaciones configuran su ayuda en línea y analizaré esto con mi mentor para ver qué podría ser útil.
Evaluar los títulos de las categorías (y proponer actualizaciones)
- Estos deben reconocer la perspectiva del público objetivo de WordPress y adaptarse a sus necesidades actuales.
- Confirma que son coherentes y cumplen con los estándares de la Guía de estilo de WordPress
- Asegúrate de que los títulos transmitan o expliquen la intención.
- Los títulos deben aclarar cualquier acción previa requerida o estados del usuario o dispositivo.
Revisar 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 son parte de una secuencia más amplia?
- ¿Los pasos distinguen a los distintos actores de la tarea (usuario, sistema/dispositivo, quién hace qué)?
- ¿Los actores se distinguen claramente?
- ¿Los pasos dividen los procesos complejos en bloques procesables?
Cómo definir y etiquetar subcategorías
- Consulta las historias de los usuarios y sigue agregando elementos a la hoja de cálculo para consultarlos en el futuro.
- Continúa 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 con los foros de asistencia.
Ten en cuenta los temas duplicados o desactualizados para borrarlos; este trabajo forense ayudará a informar y optimizar los recorridos de los usuarios
Cronograma
Hasta el 16 de agosto de 2020
- Continuar revisando la documentación de WordPress
- Familiarízate con el estilo de documentación de WordPress
- Investigar las prácticas recomendadas para los recorridos de los clientes en torno a los temas de ayuda
17 de agosto al 13 de septiembre
- Conoce a Estela y la comunidad de WordPress para trabajar con ellos
- Colabora con Estela para perfeccionar los pasos del proyecto y sugerir hitos para su finalización
- Crear un cronograma para incluir hitos y tareas semanales
- Establece una cadencia para un control de estado con Estela (a fin de abordar los obstáculos de manera oportuna).
Del 14 de septiembre al 30 de noviembre
- Trabajo inicial y desarrollo del proyecto con Estela/mentors
Del 2 al 5 de diciembre
- Enviar el informe final del producto del trabajo
Del 3 al 10 de diciembre
- Enviar una evaluación del éxito del proyecto y una evaluación 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 elegido para el 37.7% de todos los sitios web, lo que le da a WordPress un 63.6% de participación de mercado de CMS.
Gracias a este nivel de popularidad, es fundamental contar con documentación precisa y fácil de seguir para ganar el corazón del usuario de WordPress.
Al tener en cuenta el recorrido del usuario y las preguntas que determinan las posibles rutas de los usuarios, WordPress puede modernizar las categorías de ayuda y el etiquetado para responder las preguntas y solucionar los problemas de forma eficaz. De esta manera, WordPress seguirá atrayendo clientes satisfechos durante los próximos años.