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:
- Django
- Redactor técnico:
- Gabbyprecious
- Nombre del proyecto:
- Se reescribió la Guía de contribuciones para que sea más fácil de usar y navegar
- Duración del proyecto:
- Duración estándar (3 meses)
Project description
ABSTRACT
El objetivo de la guía de contribuciones de Django, como cualquier otra documentación, es guiar a los usuarios y colaboradores de código abierto, en este caso, sobre cómo y dónde pueden contribuir para que Django sea mejor y más sostenible.
Siempre es necesario crear documentación, en especial una que afecte en gran medida a la comunidad y a Django.
El objetivo de Django para el Google Summer of Docs de este año es hacer que la guía de contribución sea menos abrumadora, accesible y acogedora para los colaboradores. Este es un objetivo esencial, ya que anima a los colaboradores, entre los que me incluyo, a comenzar a contribuir a este gran framework.
Estado actual
La etapa actual de la documentación que se puede encontrar aquí no es una guía, ya que es demasiado abrumadora y no está bien estructurada, lo que lleva a una menor comprensión de la contribución en Django y no es bienvenida a los colaboradores nuevos.
Objetivos del proyecto
Analicé mis sugerencias para la documentación con mi mentor, Carlton Gibson, en el foro, y me confirmó que ayudarán con el problema abrumador de la documentación actual. Estos son los objetivos que planeo lograr con la reestructuración del documento: Reestructurar el documento Agregar secciones de lo que se debe y no se debe hacer Crear páginas individuales para secciones triviales, como solicitar y crear funciones Documentación reducida y directa al grano Glosario de palabras Índice interno creado para seguir la nueva guía Escribir una documentación más fácil de entender Segmentar el contenido en dos partes principales (sección para principiantes y colaboradores avanzados) Elaborar una guía y un estilo para nuevos escritores o colaboradores técnicos, de modo que los documentos estén actualizados y sigan los estándares.
La documentación actual ya está segmentada para colaboradores avanzados y no les da la oportunidad a los colaboradores nuevos y principiantes de usar el código abierto y Django. Aquí tienes algunos contenidos adicionales para principiantes: Sección que guía a diferentes conjuntos de colaboradores(redactores técnicos, diseñadores y desarrolladores) Una página que documenta los problemas de los usuarios por primera vez y los problemas fáciles que se pueden resolver. Toma algunas secciones de la documentación actual, reescríbelas y agrégalas a la sección para principiantes. Secciones que explican los puntos o las palabras clave que se usan en la sección avanzada.
Cronograma
Aquí hay un desglose de cómo quiero trabajar en el objetivo del proyecto como se enumera anteriormente con el calendario proporcionado por Google.
Semana de vinculación con la comunidad( del 17 de agosto al 13 de septiembre) Interactúa más con la comunidad. Continúa contribuyendo a la documentación. Obtén más sugerencias de los colaboradores. Estudia más la documentación actual y las herramientas previstas. Semana 1 a 4 Comienza a dividir la documentación en secciones según los niveles. Crea la sección para principiantes de la documentación. Semana 4 a 6 Crea una selección de lo que se debe y no se debe hacer. Escribe lo que se debe y no se debe hacer en secciones. Páginas adicionales para las secciones. Semana 7 a 9 Reescribe y mueve la documentación actual a la guía para colaboradores avanzados. Documentación reducida. Semana 10 a 12 Prepara el glosario. Actualiza el índice interno a la nueva documentación. Crea una guía y un estilo para los escritores o colaboradores técnicos que se incorporen.
Herramientas
Sphinx: Es la herramienta actual para la documentación actual. Lee los documentos.
¿Por qué este proyecto?
Creo firmemente en documentos y artículos bien escritos que abarquen a todas las personas del mundo. Además, también me encanta Django y el código abierto en general. Mi intención era contribuir a Django como principiante y creo que esta es una manera perfecta de contribuir a mi herramienta favorita y, al mismo tiempo, familiarizarme con la base de código para ofrecer más contribuciones como desarrollador(y escritor técnico). Será agradable y hermoso trabajar con una organización que se alinee con mis puntos de vista y que ha sido una gran herramienta para toda mi carrera.
¿Por qué soy la persona adecuada para este proyecto?
Creo que soy la persona adecuada en función de las siguientes consideraciones: He estado contribuyendo a Django escribiendo artículos para ayudar a los principiantes a comprender mejor el concepto de Django. Como desarrollador y con ganas de contribuir a Django, entiendo la necesidad de los colegas desarrolladores y cómo documentarlo bien para ellos. Soy un jugador de equipo y trabajaré bien con más o menos supervisión de mi mentor Carlton Gibson.