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:
- Chat del equipo de Zulip Open Source
- Escritor técnico:
- DRSSA
- Nombre del proyecto:
- Refactorización de ReadTheDocs y documentos de la API
- Duración del proyecto:
- Duración estándar (3 meses)
Project description
Me centraré en dos áreas y trabajaré en ellas en paralelo. Una de ellas es mejorar la calidad de zulip.readthedocs.io para que los colaboradores nuevos tengan menos confusión y dudas durante el proceso. Idealmente, el resultado será un camino claro y conciso desde un primer aporte hasta familiarizarse con el funcionamiento de Zulip. También pienso trabajar en zulipchat.com/api, api.md y openapi.md para que el proceso de documentación de extremos adicionales sea más fácil de comprender. Es probable que ambas partes impliquen la actualización o simplificación del contenido, la limpieza de artículos, la adición de documentación faltante para desarrolladores y la escritura o prueba de código.
El proyecto constará de cuatro fases. La primera fase incluirá pequeños proyectos de familiarización, herramientas preparatorias y una mejor comprensión de las necesidades de documentación actuales. El propósito de la segunda fase será estructurar, especificar y priorizar el trabajo dentro del contexto de los objetivos de Zulip esta temporada de otoño. Luego pasaré a la fase de implementación del proyecto. Voy a intercambiar comentarios con mentores y el resto de la comunidad de desarrolladores de Zulip. La fase final será volver atrás, revisar donde sea necesario y redactar el informe del proyecto.
Sospecho que es probable que algunas prioridades y tareas cambien a lo largo del período de trabajo como resultado del trabajo del resto, incluidas las decisiones que toman los desarrolladores principales. Creo que aprender a adaptarse bien a esos cambios sea un aspecto necesario para tener una experiencia exitosa de GSoD. Es posible que en algún momento tenga sentido posponer las ideas propuestas para más adelante. En términos generales, me centraré en asegurarme de que mi trabajo aporte valor al éxito general del proyecto de código abierto Zulip.