Esta página contiene los detalles de un proyecto de redacción técnica aceptado para la GDOC Season of Docs.
Resumen del proyecto
- Organización de código abierto:
- Mattermost
- Redactor técnico:
- @anindita_basu
- Nombre del proyecto:
- Revisa y define mejor el texto en el producto
- Duración del proyecto:
- Larga duración (5 meses)
Project description
Me uní al canal de Slack y le hice algunas preguntas a Eric. Según
su respuesta (gracias, Eric), Propongo abordar este proyecto de
la siguiente manera:
Clasifica las cadenas
Comenzaré por identificar cuáles de las cadenas (https://github.com/mattermost/mattermost-webapp/blob/master/i18n/en.json) son de la consola del sistema y cuáles son para el usuario. Propongo que primero revisemos las cadenas para el usuario.
Crea una guía de estilo para las cadenas
Me gustaría definir el estilo de mayúsculas, longitud y uso de palabras para las cadenas que se usan en los elementos de menú, los botones de acción, las etiquetas, los encabezados, las indicaciones sobre herramientas, los errores, las advertencias, las validaciones, las notificaciones y las confirmaciones (consulta una captura de pantalla de ejemplo del libro de estilo en https://github.com/AninditaBasu/AninditaBasu.github.io/blob/master/gsod/Capture7.PNG). Además, me gustaría crear una guía sobre el uso de tokens (marcadores de posición) en cadenas, en especial, cadenas compuestas.
Mi objetivo es que esta guía sea de una página de una hoja de tamaño A4, o más breve si es posible. La intención es que los desarrolladores que escriben estas cadenas encuentren la guía rápida y fácil de usar. Además, si se sigue, el texto de la IU mostrará coherencia en todas las pantallas.
Propongo hacer esto por dos razones: (a) para que haya coherencia en el texto en términos de gramática y estilo (b) para que, incluso después de que finalice la GSoD, haya un conjunto de instrucciones al que cualquiera pueda consultar rápidamente cuando escriba texto de la IU
Revisa y define mejor el texto
En función de la guía de estilo creada en el paso 2, editaré las cadenas y crearé solicitudes de extracción en GitHub.
=============
Duración
Aún no sé cuántas de las cadenas son cadenas para el usuario (que es lo que propongo revisar en este proyecto). Calculamos que la creación de la guía de estilo llevaría unas 3 semanas (desde el borrador hasta la aprobación), y este trabajo se puede realizar de forma simultánea al categorizar las cadenas como cadenas del sistema o orientadas al usuario. Propongo comenzar con la suposición de que el proyecto será un proyecto de duración estándar (3 meses), en el que tomo solo la cantidad de cadenas de revisión que sea posible dentro de este marco temporal.
Dado que ya tengo un empleo de tiempo completo, solo podría trabajar en este proyecto durante parte del día. Estoy abierto a la posibilidad de un proyecto de mayor duración si crees que mi horario laboral reducido lo necesitará.