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:
- La más importante
- Escritor 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 envié 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 dejar las cadenas para los usuarios en revisión al principio.
Crear 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, la información sobre herramientas, los errores, las advertencias, las validaciones, las notificaciones y las confirmaciones (consulta una captura de pantalla de ejemplo de una guía de estilo en https://github.com/AninditaBasu/AninditaBasu.github.io/blob/master/gsod/Capture7.PNG). Además, me gustaría crear orientación sobre el uso de tokens (marcadores de posición) en cadenas, especialmente en cadenas compuestas.
Deseo mantener esta guía en una página de una hoja de tamaño A4, más corta si es posible. La intención es que los desarrolladores que realmente escriben estas cadenas encuentren la guía de forma rápida y fácil de usar. Además, cuando se siga, el texto de la IU mostrará la coherencia en todas las pantallas.
Propongo hacer esto por dos razones: a) para que el texto sea coherente en términos de gramática y estilo, y b) de modo que incluso después de que finalice GSoD haya un conjunto de instrucciones que cualquiera pueda consultar rápidamente cuando escriba el texto de la IU.
Revisa y define mejor el texto
En función de la guía de estilo creada en el punto 2, editaré las cadenas y crearé solicitudes de extracción en GitHub.
=============
Duración
Aún no sé cuántas de ellas son cadenas para el usuario (que es lo que propongo abordar en este proyecto). Calculamos que la creación de la guía de estilo llevará alrededor de 3 semanas (desde el borrador hasta la aprobación), y este trabajo se puede hacer simultáneamente con la categorización de las cadenas como cadenas del sistema o para el usuario. Propongo comenzar con la suposición de que el proyecto será de duración estándar (3 meses), en el que solo dejo de revisar tantas cadenas de mensajes como sea posible dentro de este plazo.
Como ya tengo un empleo a tiempo completo, podría trabajar solo durante una parte del día en este proyecto. Estoy abierto a la posibilidad de un proyecto de mayor duración si crees que mi horario laboral reducido lo necesitará.