Fase atual:
Estudos de caso publicados. Consulte
linha do tempo.
Use este guia como modelo para criar a proposta de projeto da sua organização.
PROPOSAL TITLE - organization name
O título da proposta precisa ser curto e específico. "Guia de colaborador de atualização de ORGNAME" é um bom título de proposta. "Documentation Improvements" é muito vago; "Update Sections 5,7,23,99 of Contributor Guide, Create FAQ, and Create Style Guide" é muito longo.
Sobre sua organização
Nesta seção, fale sobre sua organização ou projeto em alguns parágrafos curtos. Qual problema seu projeto resolve? Quem são seus usuários e colaboradores? Há quanto tempo sua organização ou projeto existe? Dê algum contexto para nos ajudar a entender por que financiar sua proposta criaria um impacto positivo no código aberto e no mundo.
O GloriousPickle (versão atual 1.2.3, primeira versão lançada em 2009) é uma biblioteca licenciada pelo MIT para calcular facilmente a proporção perfeita de sal, açúcar, vinagre e especiarias para todos os vegetais que podem ser em conserva, em quantidades que variam de um pepino pequeno a um caminhão de raiz-forte. Nossos colaboradores são entusiastas de picles do mundo todo, e nossos usuários são chefs amadores, chefs de restaurantes e pessoas que trabalham na logística de grandes empresas e organizações de processamento de alimentos. Nosso maior usuário é uma organização que ajuda bancos de alimentos a transformar vegetais com vida útil curta em potes estáveis de conservas, ajudando a alimentar pessoas com fome em muitas comunidades e reduzindo o desperdício de alimentos. Além disso, nossos usuários enviam métricas opcionais sobre o uso do GloriousPickle, que usamos para produzir o PickleSet, um grande conjunto de dados para criar novas receitas de picles com aprendizado de máquina.
Sobre o projeto
O problema do seu projeto
Conte sobre o problema que seu projeto vai ajudar a resolver. Por que é importante para sua organização ou projeto resolver esse problema?
Os usuários querem adicionar informações sobre novas especiarias e outros ingredientes (principalmente ingredientes de culinárias não europeias) à ferramenta GloriousPickle. Infelizmente, o processo de adição dessas informações não está bem documentado, o que significa que os possíveis colaboradores precisam abrir um problema no projeto para receber ajuda ou simplesmente desistir. O processo também pressupõe que os colaboradores já estejam familiarizados com nosso processo de solicitação de envio e com o GitHub, embora muitos dos nossos usuários não sejam desenvolvedores profissionais.
Quanto mais informações sobre ingredientes tivermos, mais útil o GloriousPickle será para todos os nossos usuários.
Escopo do seu projeto
Conte sobre a documentação que sua organização vai criar, atualizar ou melhorar. Se algum trabalho não estiver sendo feito deliberadamente, inclua essa informação também. Inclua uma estimativa de tempo e se você já identificou voluntários da organização e um redator técnico para trabalhar com seu projeto.
O projeto GloriousPickle (apelido PicklePlus) vai:
- Audite a documentação atual e crie um registro de atrito da documentação para os três principais casos de uso (adicionar um novo ingrediente, adicionar um ingrediente variante e atualizar ou corrigir informações sobre um ingrediente).
- Usando o registro de dificuldades como guia para entender as lacunas na documentação, crie uma documentação atualizada para os principais casos de uso.
- Crie uma "cartilha" rápida para ajudar os colaboradores novos a usar as solicitações de envio e o GitHub para usar nosso processo.
- Incorpore o feedback dos testadores de documentação (voluntários no projeto) e da comunidade GloriousPickle.
- Trabalhar com a equipe de lançamento para atualizar a documentação no site do GloriousPickle e criar um processo para manter a documentação sincronizada com a ferramenta de atualização no futuro.
Trabalho fora do escopo deste projeto:
- Este projeto não vai criar um processo de vinculação cruzada entre diferentes grafias ou nomes do mesmo ingrediente.
- Este projeto não vai criar tutoriais do GitHub. Em vez disso, a folha de referência vai vincular o material relevante e útil.
Temos dois candidatos fortes para a redação técnica desse projeto, e estimamos que o trabalho levará três meses para ser concluído. O GloriousPickle PickleDocs SIG e @GloriousPicklePat (o mantenedor principal da API de adição de ingredientes) se comprometeram a apoiar o projeto.
Como medir o sucesso do seu projeto
Como você vai saber que a nova documentação ajudou a resolver seu problema? Quais métricas você vai usar e como vai acompanhar?
O GloriousPickle recebe uma média de dez solicitações de pull por trimestre para adicionar ou atualizar novos ingredientes (com a tag "ingredient"). A maioria dessas solicitações de pull (>60%) são de colaboradores anteriores. Acreditamos que essa documentação melhorada vai resultar em mais solicitações de pull e mais solicitações de pull de novos colaboradores. Como a maioria dos nossos colaboradores ativos começou adicionando ingredientes, acreditamos que melhorar essa documentação também vai resultar em mais colaboradores ativos no geral.
Vamos monitorar duas métricas (número de solicitações de mesclagem relacionadas a ingredientes e número de solicitações de mesclagem de novos colaboradores) mensalmente após a publicação da documentação. Também vamos acompanhar o número de colaboradores que fizeram mais de três contribuições no total, começando trimestralmente após a publicação da documentação.
Consideraremos o projeto bem-sucedido se, após a publicação da nova documentação:
- O número de solicitações de pull relacionadas a ingredientes aumenta em 20%
- O número de solicitações de mesclagem de novos colaboradores aumenta em 15%
- O número de colaboradores que fizeram >3 contribuições aumenta em 10% (no trimestre seguinte à publicação da documentação)
Cronograma
Quanto tempo você estima que esse trabalho vai levar? Você consegue dividir as tarefas do redator técnico por mês ou semana?
O projeto em si vai levar aproximadamente seis meses para ser concluído. Depois que o redator técnico for contratado, vamos passar um mês orientando-o, depois passar para a auditoria e o registro de atrito e passar os últimos meses se concentrando na criação da documentação.
| Datas | Ações necessárias |
|---|---|
| Maio | Orientação |
| De junho a agosto | Auditar a documentação atual e criar um registro de atrito |
| De setembro a outubro | Criar documentação |
| Novembro | Conclusão do projeto |
Orçamento do projeto
Diretrizes gerais
- Você pode incluir seu orçamento na proposta ou como um link separado. Se o seu orçamento tiver menos de dez itens, recomendamos incluí-lo na proposta.
- Todos os orçamentos precisam estar em dólares americanos. As bolsas variam de US$5.000 a US$15.000. Se o projeto estiver fora desse intervalo, forneça mais informações para justificar o orçamento.
- Esperamos que a maior parte do seu orçamento (pelo menos 60 a 70%) seja alocada para o redator técnico que trabalha no seu projeto. Recomendamos orçar por projeto sempre que possível.
- Esperamos que os projetos de código aberto usem ferramentas de código aberto sempre que possível. Se o projeto exigir fundos para licenças de software proprietárias ou suporte, inclua uma justificativa para o valor.
- Outras possíveis despesas incluem:
- Trabalho de design para criar branding, logotipos, modelos ou outros recursos de design para seu site de documentação
- Valores mínimos (<US$200) para brindes do projeto (camisetas ou adesivos para os participantes). Se você usar o logotipo do Google Season of Docs, ele precisa ser acompanhado pelo logotipo ou nome do seu projeto ou organização. O brinde não pode usar o nome Google.
- Subsídio mínimo para voluntários que assumem papéis de mentoria ou orientação consideráveis no projeto (recomendamos não mais de US $500 por voluntário)
- As doações para outros projetos de código aberto não podem ser mais do que 10% do orçamento total.
- Inclua outros itens do orçamento conforme necessário, junto com a justificativa do valor procurado. As justificativas de despesas devem destacar como os gastos vão contribuir para o sucesso do projeto como um todo.
Orçamento de amostra
| Item do orçamento | Valor | Total acumulado | Observações/justificações |
|---|---|---|---|
| O redator técnico faz a auditoria, atualiza, testa e publica uma nova documentação do processo de adição de ingredientes para a GloriousPickle | 5.000,00 | 5.000,00 | |
| Auxílios para voluntários | 500 | 6.500,00 | 3 subsídios para voluntários de R$ 500 cada |
| Camisetas do projeto (10 camisetas) | 150,00 | 6.650,00 | |
| Unicórnio inflável gigante (versão de 4,5 metros) | 99,99 | 6.749,99 | O unicórnio inflável será dado à equipe que responder às perguntas do redator técnico mais rapidamente durante o período de desenvolvimento do projeto. |
| TOTAL | 6.749,99 |
Informações adicionais
Inclua aqui todas as informações adicionais relevantes para sua proposta.
Experiência anterior com documentação ou redatores técnicos:se você ou qualquer um dos seus mentores já trabalhou com redatores técnicos ou desenvolveu documentação, mencione isso na sua inscrição. Descreva a documentação que você produziu e como trabalhou com o redator técnico. Por exemplo, descreva os processos de revisão que você usou ou como as habilidades do redator técnico foram úteis para seu projeto. Explique como essa experiência anterior pode ajudar você a trabalhar com um redator técnico no Google Season of Docs.
Participação anterior no Google Season of Docs, Google Summer of Code ou outros:se você ou qualquer um dos seus mentores participou do Google Summer of Code ou de um programa semelhante, mencione isso na sua inscrição. Descreva suas conquistas nesse programa. Explique como essa experiência pode influenciar a forma como você trabalha no Google Season of Docs.