Fase actual:
Datos anunciados
cronograma.
Usa esta guía como plantilla para crear la propuesta de proyecto de tu organización.
PROPOSAL TITLE: Nombre de la organización
El título de la propuesta debe ser corto y específico. "Actualizar la guía para colaboradores de ORGNAME" es un buen título de propuesta. "Mejoras en la documentación" es demasiado imprecisa; "Actualizar las secciones 5, 7, 23, 99 de la Guía para colaboradores, Crear preguntas frecuentes y Crear una guía de estilo" es demasiado larga.
Acerca de tu organización
En esta sección, cuéntanos sobre tu organización o proyecto en unos pocos párrafos. ¿Qué problema resuelve tu proyecto? ¿Quiénes son tus usuarios y colaboradores? ¿Hace cuánto tiempo existe tu organización o proyecto? Proporciona un poco de contexto para ayudarnos a comprender por qué financiar tu propuesta crearía un impacto positivo en el código abierto y en el mundo.
GloriousPickle (versión actual 1.2.3, primer lanzamiento en 2009) es una biblioteca con licencia del MIT que permite calcular fácilmente la proporción perfecta de sal, azúcar, vinagre y especias para cada verdura en recolección posible en cantidades que van desde un único pepino de bebé solitario hasta cargas de rábanos en contenedores. Nuestros colaboradores son entusiastas de los pickles de todo el mundo, y los usuarios son cocineros aficionados, chefs de restaurantes y personas que trabajan en logística para grandes empresas y organizaciones de procesamiento de alimentos. Nuestro usuario más grande es una organización que ayuda a los bancos de alimentos a convertir vegetales de corta duración en frascos de pepinillos establos, lo que ayuda a alimentar a los hambrientos de muchas comunidades y a reducir el desperdicio de comida. Además, nuestros usuarios nos envían métricas opcionales sobre el uso de GloriousPickle, que utilizamos para producir PickleSet, un gran conjunto de datos para crear nuevas recetas de pickle mediante aprendizaje automático.
Acerca de tu proyecto
El problema de tu proyecto
Cuéntanos sobre el problema que ayudará a resolver tu proyecto. ¿Por qué es importante para tu organización o proyecto resolver este problema?
Los usuarios quieren poder agregar información sobre nuevas especias y otros ingredientes (especialmente ingredientes de cocinas no europeas) a la herramienta GloriousPickle. Lamentablemente, el proceso para agregar esta información no está bien documentado, lo que significa que los posibles colaboradores deben abrir un problema en el proyecto para obtener ayuda (o simplemente se dan por vencidos). El proceso también supone que los colaboradores ya están familiarizados con nuestro proceso de solicitud de extracción y con GitHub, aunque muchos de nuestros usuarios no son desarrolladores profesionales.
Cuanta más información sobre los componentes tengamos, más útil será GloriousPickle para todos nuestros usuarios.
El alcance de tu proyecto
Indícanos qué documentación creará, actualizará o mejorará tu organización. Si hay trabajo que no se está haciendo deliberadamente, incluye también esa información. Incluye una estimación de tiempo y si ya identificaste a los voluntarios de la organización y un escritor técnico para que trabajen en tu proyecto.
El proyecto GloriousPickle (con el nombre interno PicklePlus) hará lo siguiente:
- Audita la documentación existente y crea un registro de fricción de la documentación actual para los tres casos de uso principales (agregar un ingrediente nuevo, agregar un ingrediente de la variante y actualizar o corregir la información sobre un ingrediente).
- Con el registro de fricción como guía para comprender las brechas en la documentación, crea documentación actualizada para los principales casos de uso.
- Crea una “hoja de referencia” rápida para ayudar a los colaboradores nuevos en las solicitudes de extracción y GitHub para que puedan usar nuestro proceso.
- Incorpora los comentarios de los evaluadores de documentación (voluntarios del proyecto) y la comunidad general de GloriousPickle.
- Trabaja con el equipo de lanzamientos para actualizar la documentación en el sitio de GloriousPickle y crear un proceso para mantener la documentación sincronizada con la herramienta de actualización de ahora en adelante.
Trabajo que está fuera del alcance de este proyecto:
- Este proyecto no creará un proceso para combinar diferentes grafías o nombres de un mismo ingrediente.
- Este proyecto no creará instructivos en GitHub. En su lugar, la hoja de referencia vinculará al material existente que es relevante y útil.
Tenemos dos candidatos sólidos a la redacción técnica para este proyecto y estimamos que este proceso tardará tres meses en completarse. El SIG de GloriousPickle PickleDocs y @GloriousPicklePat (el encargado de mantenimiento central de la API de adición de ingredientes) se comprometieron a respaldar el proyecto.
Medir el éxito de tu proyecto
¿Cómo sabrás que la nueva documentación te ayudó a resolver el problema? ¿Qué métricas utilizarás y cómo harás un seguimiento de ellas?
GloriousPickle recibe un promedio de diez solicitudes de extracción por trimestre para agregar o actualizar ingredientes nuevos (etiquetados como "ingrediente"). La mayoría de estas solicitudes (más del 60%) provienen de colaboradores anteriores. Creemos que esta documentación mejorada generará más solicitudes de extracción y de extracción de nuevos colaboradores. Dado que la mayoría de nuestros colaboradores activos comenzaron agregando ingredientes, también creemos que mejorar esta documentación generará colaboradores más activos en general.
Realizaremos un seguimiento mensual de dos métricas (cantidad de solicitudes de extracción relacionadas con los componentes y de las de los colaboradores nuevos) después de que se publique la documentación. También realizaremos un seguimiento del número de colaboradores que hicieron más de tres contribuciones en total, a partir de la publicación trimestral de la documentación.
Consideraríamos que el proyecto tiene éxito si, después de la publicación de la nueva documentación, se cumple lo siguiente:
- La cantidad de solicitudes de extracción relacionadas con componentes aumenta un 20%
- La cantidad de solicitudes de extracción de nuevos colaboradores aumenta un 15%
- La cantidad de colaboradores que hicieron más de 3 contribuciones aumenta en un 10% (a principios del trimestre posterior a la publicación de la documentación).
Cronograma
¿Cuánto tiempo estimas que tomará este trabajo? ¿Puedes desglosar las tareas de redacción por mes o semana?
El proyecto en sí tardará aproximadamente seis meses en completarse. Una vez que se contrate al escritor tecnológico, dedicaremos un mes a su orientación. Luego, pasaremos al registro de auditoría y de fricción y dedicaremos los últimos meses a crear la documentación.
| Fechas | Elementos de acción |
|---|---|
| Mayo de | Orientación |
| Junio-agosto | Audita la documentación existente y crea un registro de fricción |
| Septiembre a octubre | Crear documentación |
| Noviembre | Finalización del proyecto |
Presupuesto del proyecto
Lineamientos generales
- Puedes incluir el presupuesto en tu propuesta o como un vínculo independiente. Si tu presupuesto es inferior a diez elementos, te recomendamos que lo incluyas en tu propuesta.
- Todos los presupuestos deben estar expresados en dólares estadounidenses. Esperamos que los subsidios oscilen entre USD 5000 y USD 15,000. Si tu proyecto se encuentra fuera de ese rango, proporciona información adicional para justificar tu presupuesto.
- Esperamos que la mayor parte del presupuesto (60-70% como mínimo) se asigne al redactor técnico que trabaja en el proyecto. Recomendamos crear presupuestos por proyecto siempre que sea posible.
- Esperamos que los proyectos de código abierto usen herramientas de código abierto siempre que sea posible. Si tu proyecto realmente requiere fondos para licencias o asistencia de software de propiedad, incluye una justificación para el importe.
- Otros posibles gastos incluyen los siguientes:
- Trabajo de diseño para crear desarrollo de la marca, logotipos, plantillas u otros recursos de diseño para tu sitio de documentación
- Importes mínimos (menos de USD 200) para los productos promocionales del proyecto (camisetas o calcomanías para los participantes). Si usas el logotipo de la temporada de Documentos, este debe estar acompañado por el nombre o el logotipo de tu organización o proyecto. Sus productos promocionales no pueden usar el nombre de Google.
- Descuentos mínimos para voluntarios que asumen funciones considerables de mentoría o orientación en el proyecto (recomendamos no más de $500 por voluntario, por favor).
- Las donaciones posteriores a otros proyectos de código abierto no deben ser superiores al 10% de tu presupuesto total.
- Incluye otras partidas del presupuesto según sea necesario, junto con una justificación del importe solicitado. Las justificaciones de los gastos deben resaltar cómo los gastos contribuirán al éxito del proyecto en su conjunto.
Ejemplo de presupuesto
| Elemento del presupuesto | Importe | Total acumulado | Notas/justificaciones |
|---|---|---|---|
| El escritor técnico audita, actualiza, prueba y publica documentación nueva sobre el proceso para agregar ingredientes de GloriousPickle | 5,000.00 | 5,000.00 | |
| Estímulos por voluntarios | 500 | 6500.00 | 3 subsidios voluntarios por 500 cada uno |
| Camisetas de Project (10) | 150.00 | 6,650.00 | |
| Unicornio inflable gigante (versión de 4 metros) | 99.99 | 6,749.99 | Daremos el unicornio inflable al equipo que responda las preguntas del escritor técnico lo más rápido durante el período de desarrollo del proyecto |
| TOTAL | 6,749.99 |
Información adicional
Incluye aquí toda la información adicional que sea relevante para tu propuesta.
Experiencia previa con escritores técnicos o documentación: Si tú o alguno de tus mentores trabajaron con escritores técnicos antes o si desarrollaron documentación, menciona esta información en tu postulación. Describe la documentación que creaste y las formas en que trabajaste con el escritor técnico. Por ejemplo, describe cualquier proceso de revisión que hayas usado o cómo las habilidades del escritor técnico fueron útiles para tu proyecto. Explica cómo esta experiencia previa podría ayudarte a trabajar con un escritor técnico en Season of Docs.
Participación anterior en Season of Docs, Google Summer of Code o otros: Si tú o alguno de tus mentores participaron en Google Summer of Code o algún programa similar, menciónalo en tu solicitud. Describe tus logros en ese programa. Explica cómo esta experiencia puede influir en tu forma de trabajar en Season of Docs.