Fase actual:
Finalización del proyecto. Consulta el cronograma.
Esta página está destinada a organizaciones de código abierto que se encuentran en la fase de exploración del proceso de postulación de la organización. Estas ideas de proyectos son solo ejemplos para mostrar cómo las organizaciones pueden describir posibles proyectos de documentación en la página de ideas de proyectos de la organización. Las organizaciones pueden proponer proyectos que no se incluyen en esta lista.
Idea de proyecto: crea una guía de integración para colaboradores
Problema
- Los colaboradores nuevos no pueden encontrar la información de configuración que necesitan para realizar contribuciones significativas a nuestro proyecto. Algunos procesos (como contribuir a nuestras pruebas) no están documentados en absoluto.
¿Cómo mediríamos el éxito?
- Aumento en la cantidad de colaboradores nuevos
- Aumentar la cantidad de colaboradores nuevos que no escriben código (ya que facilita la colaboración en documentos o pruebas)
- Disminución en la cantidad de problemas que plantean los colaboradores nuevos
- Aumento en la cantidad de problemas cerrados etiquetados como "buen primer problema"
¿Qué habilidades necesitaría un escritor técnico para trabajar en este proyecto?
- Requisitos: Familiaridad con GitHub (o disposición para trabajar con los instructivos de GitHub)
- Deseable: Familiaridad con nuestro ejecutor de pruebas para ejecutar nuestras pruebas y actualizar la documentación para hacerlo
Voluntarios
Invita a los miembros de la comunidad a registrarse para ayudar con tareas específicas, por ejemplo:
- @JaneQDev, puedo ayudarte a responder preguntas sobre nuestras pruebas.
- @ChenPCoder, con gusto revisaré las solicitudes de extracción de Documentos
- @ErichJEngineer, puedes explicar el proceso de contribución actual con el escritor técnico.
Información de contacto
- Los redactores técnicos interesados en trabajar en este proyecto deben enviar un correo electrónico a email@project. Incluye vínculos a tu trabajo de redacción técnica o a tu portafolio, currículum o CV.
Idea de proyecto: escribir instructivos para usar nuestra biblioteca con …
Problema
- Nuestro proyecto recibe muchos problemas que plantean los usuarios que intentan usar nuestra biblioteca con $TechnologyX. No tenemos una guía clara para la integración con $TechnologyX, y puede ser complicado.
¿Cómo mediríamos el éxito?
- Disminución en la cantidad de problemas etiquetados como "$TechnologyX"
- Aumento en la cantidad de solicitudes de extracción de colaboradores nuevos que nos ayudan a corregir errores o a agregar documentación sobre $TechnologyX
- Más vínculos a nuestro proyecto desde los proyectos de $TechnologyX
¿Qué habilidades necesitaría un escritor técnico para trabajar en este proyecto?
- Deseable: Tener cierta familiaridad con $TechnologyX
Voluntarios
Invita a los miembros de la comunidad a registrarse para ayudar con tareas específicas, por ejemplo:
- @JaneQDev, puedo ayudarte a responder preguntas sobre $TechnologyX
- @ChenPCoder, con gusto revisaré las solicitudes de extracción de Documentos
Información de contacto
- Los redactores técnicos interesados en trabajar en este proyecto deben enviar un correo electrónico a email@project. Incluye vínculos a tu trabajo de redacción técnica o a tu portafolio, currículum o CV.
Idea del proyecto: reorganizar nuestra documentación
Problema
- Nuestra documentación es extensa y desorganizada. Muchos usuarios dejan de intentar encontrar respuestas en la documentación y, en su lugar, plantean problemas o hacen preguntas en nuestros foros. Nuestras páginas no aparecen en los resultados de la búsqueda, incluso para las palabras clave relevantes.
¿Cómo mediríamos el éxito?
- Mejor SEO para nuestra documentación
- Disminución en la cantidad de problemas planteados sobre temas que se abordan en la documentación
- Aumento en la cantidad de contribuciones a la documentación
¿Qué habilidades necesitaría un escritor técnico para trabajar en este proyecto?
- Deseable: Experiencia en la reorganización de conjuntos de documentación grandes y maduros, conocimiento del SEO
Voluntarios
Invita a los miembros de la comunidad a registrarse para ayudar con tareas específicas, por ejemplo:
- @ChenPCoder, con gusto revisaré las solicitudes de extracción de Documentos
Información de contacto
- Los redactores técnicos interesados en trabajar en este proyecto deben enviar un correo electrónico a email@project. Incluye vínculos a tu trabajo de redacción técnica o a tu portafolio, currículum o CV.
Idea del proyecto: ejecutar una solución de problemas de documentación
Problema
- Tenemos muchos errores pequeños y problemas antiguos relacionados con nuestra documentación. A nuestra comunidad le encantaría ayudar a limpiar, pero necesitamos que alguien organice y ejecute la reparación.
¿Cómo mediríamos el éxito?
- Cantidad de problemas relacionados con la documentación cerrados
- Aumento en la cantidad de contribuciones a la documentación y de colaboradores nuevos
¿Qué habilidades necesitaría un escritor técnico para trabajar en este proyecto?
- Deseable: Experiencia en la ejecución de una solución de problemas de documentación
- Excelentes habilidades organizativas
Voluntarios
Invita a los miembros de la comunidad a registrarse para ayudar con tareas específicas, por ejemplo:
- @ChenPCoder, puedes ayudar a organizar el video y el chat para la solución y a encontrar voluntarios en otras zonas horarias.
Información de contacto
- Los redactores técnicos interesados en trabajar en este proyecto deben enviar un correo electrónico a email@project/abrir un problema o preguntar en nuestro foro. Incluye vínculos a tu trabajo de redacción técnica o a tu portafolio, currículum o CV.
Idea de proyecto: Realiza una auditoría de documentación
Problema
- No tenemos una buena idea del estado de nuestra documentación. Es difícil priorizar las mejoras de la documentación porque no tenemos una hoja de ruta ni una idea de cuáles son los problemas más urgentes. También tenemos mucho contenido desactualizado que se debe borrar o archivar.
¿Cómo mediríamos el éxito?
- Creación de una hoja de ruta de documentación con la aprobación general de la comunidad
- Disminución de la cantidad de páginas de documentación desactualizadas o incorrectas
¿Qué habilidades necesitaría un escritor técnico para trabajar en este proyecto?
- Deseable: Experiencia en la realización de auditorías de documentos
Voluntarios
Invita a los miembros de la comunidad a registrarse para ayudar con tareas específicas, por ejemplo:
- @JaneQCoder, ¿puedes ayudar a coordinar la presentación de la hoja de ruta de la documentación en nuestra reunión de la comunidad?
Información de contacto
- Los redactores técnicos interesados en trabajar en este proyecto deben enviar un correo electrónico a email@project/abrir un problema o preguntar en nuestro foro. Incluye vínculos a tu trabajo de redacción técnica o a tu portafolio, currículum o CV.
Información relacionada
- La página Promoción y prensa incluye logotipos y otro contenido que puedes usar cuando hables de la Temporada de Documentos de Google.
- En este video de PyCon Australia 2017, Daniele Procida ofrece sugerencias para organizar tu documentación de modo que las personas la encuentren útil: What nobody tells you about documentation.