Fase actual:
Desarrollo de la documentación. Consulta el 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 guía para colaboradores de ORGNAME" es un buen título de propuesta. "Mejoras de la documentación" es demasiado imprecisa; "Actualizar los artículos 5, 7, 23, 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 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 algo 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, primera versión 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 vegetal se puede recolectar en cantidades que van desde un único pepino de bebé solitario hasta cargas de rábanos en contenedores. Nuestros colaboradores son entusiastas de los pepinillos de todo el mundo, y nuestros usuarios son chefs de cocina casera, 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 baja vida en frascos de pepinillos, lo que ayuda a alimentar a las personas hambrientas en muchas comunidades y a reducir el desperdicio de comida. 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 pickle a través del 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 las 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 tienen que 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 tengamos sobre los ingredientes, más útil será GloriousPickle para todos los usuarios.
El alcance de tu proyecto
Indícanos qué documentación creará, actualizará o mejorará tu organización. Si deliberadamente no se está realizando algún trabajo, 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 de PicklePlus) realizará 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 ayudarlos a usar nuestro proceso.
- Incorpora comentarios de verificadores de documentación (voluntarios del proyecto) y de la comunidad más amplia 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 la vinculación entre diferentes formas o nombres de un mismo ingrediente.
- En este proyecto no se crearán instructivos de GitHub. En su lugar, la hoja de referencia vinculará a material existente que es relevante y útil.
Tenemos dos candidatos sólidos para la redacción de este proyecto, y estimamos que completar este trabajo llevará tres meses. El grupo SIG de GloriousPickle PickleDocs y @GloriousPicklePat (el encargado de mantenimiento central de la API para agregar ingredientes) se comprometieron a apoyar 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 usarás y cómo las harás un seguimiento?
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 de extracción (más del 60%) son de colaboradores anteriores. Creemos que esta documentación mejorada generará más solicitudes de extracción y más solicitudes 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 (la cantidad de solicitudes de incorporación relacionadas con los ingredientes y la cantidad de solicitudes de incorporación de nuevos colaboradores) mensualmente después de que se publique la documentación. También haremos un seguimiento del número de colaboradores que hayan realizado más de tres contribuciones en general, comenzando trimestralmente después de que se publique la documentación.
Consideraremos 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 los ingredientes aumenta en un 20%
- La cantidad de solicitudes de extracción de nuevos colaboradores aumenta en un 15%
- La cantidad de colaboradores que realizaron más de 3 contribuciones aumenta en un 10% (a partir 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 escritor técnico por mes o semana?
El proyecto en sí tardará aproximadamente seis meses en completarse. Una vez contratado al escritor técnico, dedicaremos un mes a su orientación, pasaremos al registro de auditoría y de fricción y dedicaremos los últimos meses a centrarnos en la creación de la documentación.
| Fechas | Medidas de acción |
|---|---|
| Mayo | Orientación |
| Junio-agosto | Audita la documentación existente y crea un registro de inconvenientes |
| Septiembre - 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 aparte. Si tu presupuesto es inferior a diez elementos, te recomendamos que lo incluyas en tu propuesta.
- Todos los presupuestos deben ser en dólares estadounidenses. Esperamos que los subsidios oscilen entre USD 5,000 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 de tu presupuesto (mínimo del 60% al 70%) se asigne al redactor técnico que trabaja en tu proyecto. Recomendamos crear presupuestos por proyecto siempre que sea posible.
- Esperamos que los proyectos de código abierto utilicen herramientas de este tipo siempre que sea posible. Si tu proyecto requiere de fondos para licencias de software propio o asistencia, incluye una justificación del importe.
- Otros gastos posibles incluyen los siguientes:
- Trabajo de diseño para crear elementos de marca, logotipos, plantillas u otros elementos de diseño para su 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 usa el logotipo de Temporada de Documentos de Google, debe estar acompañado por el logotipo o nombre de su proyecto, organización o proyecto. Su producto promocional no puede tener el nombre de Google.
- Descuentos mínimos para voluntarios que asumen funciones considerables de tutoría u 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% del total de tu presupuesto.
- Incluye otras partidas presupuestarias, según sea necesario, junto con una justificación del importe solicitado. Las justificaciones de gastos deben resaltar cómo el gasto contribuirá al éxito del proyecto en su conjunto.
Ejemplo de presupuesto
| Elemento del presupuesto | Importe | Total acumulado | Notas y justificaciones |
|---|---|---|---|
| El escritor técnico audita, actualiza, prueba y publica nueva documentación sobre el proceso para agregar ingredientes de GloriousPickle | 5,000.00 | 5,000.00 | |
| Recompensas para voluntarios | 500 | 6,500.00 | 3 subsidios por voluntarios x 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 antes con escritores técnicos o desarrollaron documentación, menciona esto en tu solicitud. Describe la documentación que produjiste 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 anterior puede ayudarte a trabajar con un escritor técnico en Google Season of Docs.
Participación anterior en Google Season of Docs, Google Summer of Code y otros: Si tú o alguno de tus mentores participaron en Google Summer of Code o en algún programa similar, menciona esto en tu solicitud. Describe tus logros en ese programa. Explica cómo esta experiencia puede influir en la forma en que trabajas en Google Season of Docs.