Fase actual:
Finalización del proyecto. Consulta el cronograma.
Usa esta guía como plantilla para crear la propuesta de proyecto de tu organización.
TÍTULO DE LA PROPUESTA: nombre de la organización
El título de tu propuesta debe ser breve y específico. “Actualizar la Guía para colaboradores de ORGNAME” es un buen título para la propuesta. “Mejoras en la documentación” es demasiado vago. “Actualizar las secciones 5, 7, 23 y 99 de la Guía para colaboradores, crear preguntas frecuentes y crear una guía de estilo” es demasiado largo.
Acerca de tu organización
En esta sección, cuéntanos sobre tu organización o proyecto en algunos párrafos breves. ¿Qué problema resuelve tu proyecto? ¿Quiénes son tus usuarios y colaboradores? ¿Cuánto tiempo lleva funcionando tu organización o proyecto? Proporciona algunos detalles para ayudarnos a comprender por qué financiar tu propuesta generaría un impacto positivo en el código abierto y en el mundo.
GloriousPickle (versión actual 1.2.3, primera versión en 2009) es una biblioteca con licencia de MIT para calcular fácilmente la proporción perfecta de sal, azúcar, vinagre y especias para cada vegetal encurtable posible, en cantidades que van desde un solo pepino bebé solitario hasta contenedores llenos de rábanos. Nuestros colaboradores son entusiastas de los encurtidos de todo el mundo, y nuestros usuarios son chefs caseros, 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 con corta vida útil en frascos estables de encurtidos, lo que ayuda a alimentar a personas hambrientas en muchas comunidades y a reducir el desperdicio de alimentos. Además, nuestros usuarios nos envían métricas opcionales sobre su uso de GloriousPickle, que usamos para producir PickleSet, un gran conjunto de datos para crear nuevas recetas de pepinillos a través del aprendizaje automático.
Acerca de tu proyecto
El problema de tu proyecto
Cuéntanos sobre el problema que tu proyecto ayudará a resolver. ¿Por qué es importante para tu organización o proyecto resolver este problema?
Los usuarios quieren poder agregar información sobre especias nuevas y otros ingredientes (en especial, 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). En el proceso, también se supone que los colaboradores ya están familiarizados con nuestro proceso de solicitudes de extracción y con GitHub, aunque muchos de nuestros usuarios no son desarrolladores profesionales.
Cuanto más información sobre los ingredientes tengamos, más útil será GloriousPickle para todos nuestros usuarios.
Alcance de tu proyecto
Cuéntanos sobre la documentación que tu organización creará, actualizará o mejorará. Si no se está realizando algún trabajo de forma deliberada, incluye esa información también. Incluye una estimación del tiempo y si ya identificaste voluntarios de la organización y un escritor técnico para trabajar en tu proyecto.
El proyecto GloriousPickle (con el nombre en código 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 variante y actualizar o corregir información sobre un ingrediente).
- Usa el registro de fricciones como guía para comprender las carencias de la documentación y crea documentación actualizada para los casos de uso principales.
- Crea una “hoja de referencia” rápida para ayudar a los colaboradores que son nuevos en las solicitudes de extracción y GitHub a usar nuestro proceso.
- Incorporar los comentarios de los verificadores de documentación (voluntarios en el proyecto) y de la comunidad más amplia de GloriousPickle
- Trabajar con el equipo de lanzamiento 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 en el futuro
Trabajo que está fuera del alcance de este proyecto:
- Este proyecto no creará un proceso para la vinculación cruzada entre diferentes grafías o nombres para el mismo ingrediente.
- Este proyecto no creará ningún instructivo de GitHub. En su lugar, la hoja de referencia vinculará a material existente que sea relevante y útil.
Tenemos dos candidatos sólidos para la redacción técnica de este proyecto y estimamos que este trabajo llevará tres meses en completarse. El SIG de PickleDocs de GloriousPickle y @GloriousPicklePat (el encargado principal de la API de adición de ingredientes) se comprometieron a respaldar el proyecto.
Mide el éxito de tu proyecto
¿Cómo sabrás que tu nueva documentación te ayudó a resolver el problema? ¿Qué métricas utilizarás y cómo les harás un seguimiento?
GloriousPickle recibe un promedio de diez solicitudes de extracción por trimestre para agregar o actualizar ingredientes nuevos (marcados como "ingrediente"). La mayoría de estas solicitudes de extracción (>60%) provienen de colaboradores anteriores. Creemos que esta documentación mejorada generará más solicitudes de extracción y más solicitudes de extracción de colaboradores nuevos. Dado que la mayoría de nuestros colaboradores activos comenzaron por agregar ingredientes, también creemos que mejorar esta documentación generará más colaboradores activos en general.
Después de que se publique la documentación, haremos un seguimiento de dos métricas (cantidad de solicitudes de extracción relacionadas con ingredientes y cantidad de solicitudes de extracción de colaboradores nuevos) mensualmente. También haremos un seguimiento de la cantidad de colaboradores que hayan realizado más de tres contribuciones en total, a partir de informes trimestrales después de que se publique la documentación.
Consideraremos que el proyecto tuvo éxito si, después de la publicación de la nueva documentación, se cumple con lo siguiente:
- La cantidad de solicitudes de extracción relacionadas con los ingredientes aumenta un 20%.
- La cantidad de solicitudes de extracción de colaboradores nuevos aumenta un 15%.
- La cantidad de colaboradores que realizaron más de 3 contribuciones aumenta un 10% (a partir del trimestre posterior a la publicación de la documentación)
Cronograma
¿Cuánto tiempo crees que llevará este trabajo? ¿Puedes desglosar las tareas del escritor técnico por mes o semana?
El proyecto en sí tardará aproximadamente seis meses en completarse. Una vez que se contrate al escritor técnico, pasaremos un mes en la orientación para escritores técnicos, luego, pasaremos al registro de auditoría y fricción, y pasaremos los últimos meses enfocándonos en crear la documentación.
| Fechas | Medidas de acción |
|---|---|
| Mayo | Orientación |
| Junio-agosto | Audita la documentación existente y crea un registro de fricciones |
| De septiembre a octubre | Crea documentación |
| Noviembre | Finalización del proyecto |
Presupuesto del proyecto
Lineamientos generales
- Puedes incluir tu presupuesto en la propuesta o como un vínculo independiente. Si tu bugeto es inferior a diez elementos, te recomendamos que lo incluyas en tu propuesta.
- Todos los presupuestos deben estar en dólares estadounidenses. Esperamos que las subvenciones oscilen entre USD 5,000 y USD 15,000. Si tu proyecto está fuera de ese rango, proporciona información adicional para justificar tu presupuesto.
- Esperamos que la mayor parte de tu presupuesto (entre el 60 y el 70% como mínimo) se asigne al escritor técnico que trabaja en tu proyecto. Recomendamos que establezcas un presupuesto 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 requiere fondos para licencias de software o asistencia de propiedad exclusiva, incluye una justificación del importe.
- Entre otros posibles gastos, se incluyen los siguientes:
- Trabajo de diseño para crear desarrollo de la marca, logotipos, plantillas y otros recursos de diseño para tu sitio de documentación
- Importes mínimos (<USD 200) para artículos promocionales del proyecto (camisetas o calcomanías para los participantes). Si usas el logotipo de la Temporada de documentos de Google, debe ir acompañado del logotipo o el nombre de tu organización o proyecto. En tu material promocional, no puedes usar el nombre Google.
- Becas mínimas para voluntarios que desempeñen roles de orientación o supervisión considerables en el proyecto (recomendamos no más de USD 500 por voluntario)
- Las donaciones descendentes a otros proyectos de código abierto no deben ser superiores al 10% del presupuesto total.
- Incluye otros elementos del presupuesto según sea necesario, junto con la justificación del importe que se busca. Las justificaciones de gastos deben destacar cómo la inversión contribuirá al éxito del proyecto en su conjunto.
Ejemplo de presupuesto
| Artículo del presupuesto | Importe | Total acumulado | Notas/justificaciones |
|---|---|---|---|
| El escritor técnico audita, actualiza, prueba y publica nueva documentación del proceso de agregar ingredientes para GloriousPickle | 5000.00 | 5000.00 | |
| Becas para voluntarios | 500 | 6,500.00 | 3 becas para voluntarios por un total de USD 500 cada una |
| Camisetas del proyecto (10 camisetas) | 150.00 | 6,650.00 | |
| Unicornio inflable gigante (versión de 4.5 m) | 99.99 | 6,749.99 | Le daremos el unicornio inflable al equipo que responda las preguntas del escritor técnico más rápido durante el período de desarrollo del proyecto. |
| TOTAL | 6,749.99 |
Información adicional
Incluye aquí cualquier información adicional que sea relevante para tu propuesta.
Experiencia previa con documentación o redactores técnicos: Si tú o alguno de tus mentores trabajaron con redactores técnicos antes o desarrollaron documentación, indícalo en tu solicitud. Describe la documentación que produjiste y las formas en que trabajaste con el escritor técnico. Por ejemplo, describe los procesos de revisión que usaste o cómo las habilidades del escritor técnico fueron útiles para tu proyecto. Explica cómo esta experiencia previa puede ayudarte a trabajar con un redactor técnico en la Temporada de Documentos de Google.
Participación previa en Google Season of Docs, Google Summer of Code o otros: Si tú o alguno de tus mentores participaron en Google Summer of Code o un programa similar, indícalo en tu postulación. Describe tus logros en ese programa. Explica cómo esta experiencia puede influir en la forma en que trabajas en la Temporada de Documentos de Google.