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:
- Django
- Escritor técnico:
- GabbyPrecious
- Nombre del proyecto:
- Reescribe la guía de contribución para que sea más fácil de usar y de navegar
- Duración del proyecto:
- Duración estándar (3 meses)
Project description
RESUMEN
El objetivo de la guía de contribución de Django, como toda otra documentación, es guiar a los colaboradores de código abierto y de usuarios en este caso sobre cómo y dónde pueden contribuir a que Django sea mejor y más sustentable.
Siempre hay necesidad de hacer documentos, en especial uno que afecte de forma considerable 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, al que yo pertenezco para comenzar a contribuir a este gran marco de trabajo.
Estado actual
La etapa actual de la documentación, que se puede encontrar aquí, no es realmente una guía, ya que es demasiado abrumadora y no está bien estructurada, y conduce a una menor comprensión de las contribuciones en Django y a que no es bienvenido a los colaboradores nuevos.
Objetivos del proyecto
Debatí mis sugerencias para la documentación con mi mentor, Carlton Gibson, en el foro, y él aprueba que ayudará con el problema abrumador con la documentación actual. Estos son los objetivos que pienso para lograr la reestructuración del documento: Reestructurar el documento Agregar sugerencias y precauciones por secciones Crear páginas únicas para secciones triviales, como solicitar y crear funciones Documentación reducida y directa Glosario para palabras Índice interno creado para seguir la nueva guía Escribir una documentación más fácil y cercana Segmentar el contenido en dos partes principales y mantener el estilo para las guías técnicas para principiantes y Contribuidores avanzados)
La documentación actual ya está dirigida a colaboradores avanzados y no da lugar a colaboradores principiantes ni nuevos del código abierto y de Django. Aquí tienes contenido adicional para principiantes: Sección que guía a diferentes conjuntos de colaboradores(escritores técnicos, diseñadores y desarrolladores) Una página que documenta problemas iniciales y problemas sencillos que se pueden resolver. Lee algunas secciones de la documentación actual, vuelve a escribirlas y agrégalas a la sección para principiantes. Secciones que explican los puntos o palabras clave usados en la sección avanzada.
Cronograma
Aquí habrá un desglose de cómo quiero trabajar en el objetivo del proyecto, tal como se enumera arriba con el calendario proporcionado por Google.
Semana de integración de la comunidad 0
Herramientas
Sphinx: herramienta actual para la documentación actual. Lee los documentos.
¿Por qué este proyecto?
Creo fundamentalmente en la documentación y los artículos bien redactados para incluir a todas las personas en una parte del mundo. Además de eso, me encantan Django y el código abierto en su conjunto. Quería contribuir con Django como principiante y creo que esta es una manera perfecta de contribuir a mi herramienta favorita, a la vez que me familiarizo con la base de código para ofrecer más aportes como desarrollador(y escritor técnico). Será agradable y hermoso trabajar con una organización que se alinee con mis puntos de vista y ha sido una gran herramienta para toda mi carrera.
¿Por qué soy la persona indicada para este proyecto?
Creo que soy la persona indicada según las siguientes cuentas: Estuve contribuyendo con Django escribiendo artículos para ayudar a los principiantes a comprender el concepto de Django más. Como soy desarrollador y quiero contribuir con Django, entiendo la necesidad de otros desarrolladores y cómo documentarlos bien para ellos. Trabajo en equipo y voy a trabajar bien con menos o más supervisión de mi mentor Carlton Gibson.