Proyecto de chat en equipo de código abierto de Zulip
Organiza tus páginas con colecciones
Guarda y categoriza el contenido según tus preferencias.
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:
- Chat en equipo de Zulip de código abierto
- Redactor técnico:
- drrosa
- Nombre del proyecto:
- Refactorización de ReadTheDocs y la documentación de la API
- Duración del proyecto:
- Duración estándar (3 meses)
Project description
Me enfocaré en dos áreas y trabajaré en ellas en paralelo. Uno de ellos es mejorar la calidad de zulip.readthedocs.io para que los colaboradores nuevos encuentren menos confusión y dudas en el camino. Idealmente, el resultado será una ruta clara y concisa desde una primera contribución hasta familiarizarse con el funcionamiento de Zulip. También planeo 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 entender. Es probable que ambas partes impliquen actualizar o simplificar el contenido, ordenar los artículos, agregar la documentación para desarrolladores faltante y, también, escribir o probar 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 objetivo de la segunda fase será estructurar, especificar y priorizar el trabajo en el contexto de los objetivos de Zulip esta temporada de otoño. Luego pasaré a la fase de implementación del proyecto. Me comunicaré con los mentores y el resto de la comunidad de desarrolladores de Zulip para obtener comentarios. La fase final será mirar hacia atrás, revisar lo que sea necesario y escribir el informe del proyecto.
Sospecho que es probable que algunas prioridades y tareas cambien a lo largo del período de trabajo como resultado de lo que están haciendo los demás, incluidas las decisiones que toman los desarrolladores principales. Espero 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 general, me enfocaré en asegurarme de que mi trabajo aporte valor al éxito general del proyecto de código abierto de Zulip.
Salvo que se indique lo contrario, el contenido de esta página está sujeto a la licencia Atribución 4.0 de Creative Commons. Para obtener más información, consulta las políticas del sitio de Google Developers. Java es una marca registrada de Oracle o sus afiliados.
Última actualización: 2024-11-08 (UTC)
[[["Fácil de comprender","easyToUnderstand","thumb-up"],["Resolvió mi problema","solvedMyProblem","thumb-up"],["Otro","otherUp","thumb-up"]],[["Falta la información que necesito","missingTheInformationINeed","thumb-down"],["Muy complicado o demasiados pasos","tooComplicatedTooManySteps","thumb-down"],["Desactualizado","outOfDate","thumb-down"],["Problema de traducción","translationIssue","thumb-down"],["Problema con las muestras o los códigos","samplesCodeIssue","thumb-down"],["Otro","otherDown","thumb-down"]],["Última actualización: 2024-11-08 (UTC)"],[[["This project aims to improve the Zulip developer documentation for easier contribution and understanding."],["The focus is on refining ReadTheDocs for new contributors and enhancing API documentation for easier endpoint documentation."],["The project will involve restructuring, simplifying, and adding content, along with code writing and testing."],["The project is divided into four phases, starting with familiarization and ending with a final report, with continuous feedback and adaptation."],["The project's success is measured by its contribution to the overall success of the Zulip open-source project."]]],["The project focuses on improving Zulip's documentation for contributors and developers. Key actions include enhancing the clarity and conciseness of `zulip.readthedocs.io`, and improving the ease of documenting API endpoints on `zulipchat.com/api`, `api.md`, and `openapi.md`. The work will involve updating content, decluttering articles, adding missing information, and testing code. The project will unfold in four phases: familiarization, structuring/prioritization, implementation, and revision/reporting, with ongoing feedback from the Zulip community. The project will be adaptable to potential changes in priorities.\n"]]
