Fase actual:
Datos anunciados
cronograma.
Esta página es para organizaciones de código abierto en la fase de exploración del proceso de aplicació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 para proyectos de la organización. Las organizaciones pueden proponer proyectos que no están incluidos 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 las contribuciones a nuestras pruebas) no están documentados.
¿Cómo podríamos medir el éxito?
- de aumento en la cantidad de colaboradores nuevos
- Aumento en la cantidad de colaboradores nuevos que no son de código (gracias a que es más fácil contribuir a documentos o pruebas)
- de 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?
- Debe tener: Conocimientos de GitHub (o deseo de trabajar mediante los instructivos de GitHub)
- Deseable: Conocer nuestro ejecutor de pruebas para ejecutar las pruebas y actualizar la documentación correspondiente
Voluntarios
Incentiva a los miembros de la comunidad a registrarse para recibir ayuda con tareas específicas, como las siguientes:
- @JaneQDev, puede ayudarnos a responder preguntas sobre nuestras pruebas
- @ChenPCoder, me alegra revisar las solicitudes de extracción de documentos
- @ErichJEngineer, puede revisar el proceso de contribución actual con el escritor técnico
Información de contacto
- Los escritores 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 portfolio, currículum vitae o CV.
Idea del 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 podríamos medir el éxito?
- Disminución de la cantidad de problemas etiquetados como "$TechnologyX"
- Aumento en la cantidad de solicitudes de extracción de nuevos colaboradores que nos ayudan a corregir errores o ampliar la documentación en torno a $TechnologyX
- Más vínculos a nuestro proyecto de los proyectos de $TechnologyX
¿Qué habilidades necesitaría un escritor técnico para trabajar en este proyecto?
- Deseable: Estar familiarizados con $TechnologyX
Voluntarios
Incentiva a los miembros de la comunidad a registrarse para recibir ayuda con tareas específicas, como las siguientes:
- @JaneQDev, puede ayudarte a responder preguntas sobre $TechnologyX
- @ChenPCoder, me alegra revisar las solicitudes de extracción de documentos
Información de contacto
- Los escritores 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 portfolio, currículum o CV.
Idea de 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 cambio, simplemente 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 podríamos medir el éxito?
- Mejor SEO para nuestra documentación
- Disminución de la cantidad de problemas planteados en los temas que se abordan en la documentación
- Aumento en la cantidad de contribuciones de 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 extensos y maduros, comprensión de la SEO
Voluntarios
Incentiva a los miembros de la comunidad a registrarse para recibir ayuda con tareas específicas, como las siguientes:
- @ChenPCoder, me alegra revisar las solicitudes de extracción de documentos
Información de contacto
- Los escritores 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 portfolio, currículum o CV.
Idea del proyecto: ejecutar un correctit de documentación
Problema
- Tenemos muchos errores y problemas antiguos relacionados con nuestra documentación. Nuestra comunidad estará encantada de colaborar y ayudar a limpiar, pero necesitamos a alguien que organice y ejecute el corrector en sí.
¿Cómo podríamos medir el éxito?
- Cantidad de problemas relacionados con la documentación cerrados
- Aumento en la cantidad de contribuciones de documentación y nuevos colaboradores
¿Qué habilidades necesitaría un escritor técnico para trabajar en este proyecto?
- Es bueno tener: Experiencia en la ejecución de correcciones de documentación
- Grandes habilidades organizativas
Voluntarios
Incentiva a los miembros de la comunidad a registrarse para recibir ayuda con tareas específicas, como las siguientes:
- @ChenPCoder, puede ayudar a organizar el video y el chat de la instalación, a encontrar voluntarios en otras zonas horarias.
Información de contacto
- Los escritores técnicos interesados en trabajar en este proyecto deben enviar un correo electrónico a email@project/abrir un problema/preguntar en nuestro foro. Incluye vínculos a tu trabajo de redacción técnica o a tu portfolio, currículum o CV.
Idea de proyecto: auditar la documentación
Problema
- No tenemos una idea clara del estado de nuestra documentación. Es difícil priorizar las mejoras de 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 debería borrarse o archivarse.
¿Cómo podríamos medir el éxito?
- Creación de una hoja de ruta de la 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 auditorías de documentos
Voluntarios
Incentiva a los miembros de la comunidad a registrarse para recibir ayuda con tareas específicas, como las siguientes:
- @JaneQCoder, puede ayudarnos a coordinar la presentación de la documentación en nuestra reunión comunitaria.
Información de contacto
- Los escritores técnicos interesados en trabajar en este proyecto deben enviar un correo electrónico a email@project/abrir un problema/preguntar en nuestro foro. Incluye vínculos a tu trabajo de redacción técnica o a tu portfolio, currículum o CV.
Información relacionada
- En la página de promoción y prensa, se incluyen logotipos y otro contenido que puedes usar cuando te refieras a la temporada de Documentos.
- En este video de PyCon Australia 2017, se ofrecen sugerencias sobre cómo organizar la documentación para que a las personas les resulte útil: Lo que nadie te cuenta sobre la documentación de Daniele Procida.