Fase atual:
desenvolvimento da documentação. Consulte o
cronograma.
Use este guia como modelo para criar a proposta de projeto da sua organização.
PROPOSAL TITLE: nome da organização
O título da proposta deve ser curto e específico. "Atualizar guia do colaborador de ORGNAME" é um bom título para a proposta. "Melhorias na documentação" é muito vago; "Atualizar as seções 5, 7, 23, 99 do Guia do colaborador, Criar perguntas frequentes e Criar guia de estilo" é muito longo.
Sobre sua organização
Nesta seção, fale um pouco sobre sua organização ou projeto. Que 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 o financiamento da sua proposta criaria um impacto positivo no código aberto e no mundo.
GloriousPickle (versão atual 1.2.3, primeiro lançamento em 2009) é uma biblioteca licenciada pelo MIT para calcular facilmente a proporção perfeita de sal, açúcar, vinagre e especiarias para cada vegetal em conserva, em quantidades que variam de um único pepino solitário a carga de rabanetes em contêineres. Nossos colaboradores são entusiastas de conservas de todo o mundo, e nossos usuários são chefs domésticos, chefs de restaurantes e pessoas que trabalham em logística para grandes empresas e organizações de processamento de alimentos. Nosso maior usuário é uma organização que ajuda bancos de alimentos a transformar vegetais de última hora em potes estáveis de picles, ajudando a alimentar pessoas com fome em muitas comunidades e reduzindo o desperdício de alimentos. Além disso, nossos usuários nos 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 por meio do aprendizado de máquina.
Sobre seu projeto
Problema do seu projeto
Fale sobre o problema que seu projeto ajudará a resolver. Por que é importante para sua organização ou projeto resolver esse problema?
Os usuários querem poder adicionar informações sobre novos temperos e outros ingredientes (especialmente ingredientes de culinárias não europeias) à ferramenta GloriousPickle. Infelizmente, o processo para adicionar essas informações não está bem documentado, o que significa que possíveis colaboradores precisam abrir um problema no projeto para obter ajuda (ou simplesmente desistem). 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 de 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 projeto
Informe qual documentação sua organização vai criar, atualizar ou melhorar. Se algum trabalho deliberadamente não estiver sendo feito, 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 o projeto.
O projeto GloriousPickle (com o codinome PicklePlus) irá:
- Audite a documentação atual e crie um registro de atrito da documentação atual para os três principais casos de uso (adicionar um novo ingrediente, adicionar uma variante e atualizar ou corrigir informações sobre um ingrediente).
- Use o registro de atrito como guia para entender as lacunas na documentação e crie documentação atualizada para os principais casos de uso.
- Crie uma "folha de referência" rápida para ajudar colaboradores novos a solicitações de envio e o GitHub a fim de ajudá-los a usar nosso processo.
- Incorpore o feedback dos testadores de documentação (voluntários no projeto) e da comunidade GloriousPickle em geral.
- Trabalhe 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 daqui para frente.
Trabalho que está fora do escopo deste projeto:
- Este projeto não criará um processo de associação de grafias ou nomes diferentes para o mesmo ingrediente.
- Este projeto não criará tutoriais do GitHub. Em vez disso, a folha de referência terá um link para material relevante e útil.
Temos dois excelentes candidatos técnicos para este projeto e estimamos que esse trabalho levará três meses para ser concluído. O GloriousPickle PickleDocs SIG e @GloriousPicklePat (o principal mantenedor 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 o problema? Quais métricas você usará e como elas serão rastreadas?
O GloriousPickle recebe uma média de dez solicitações pull por trimestre para adicionar ou atualizar novos ingredientes (marcados como "ingrediente"). A maioria dessas solicitações (>60%) é de colaboradores anteriores. Acreditamos que essa documentação aprimorada resultará em mais solicitações e em mais solicitações de novos colaboradores. Como a maioria dos nossos colaboradores ativos começou adicionando ingredientes, também acreditamos que melhorar esta documentação resultará em um número maior de colaboradores ativos.
Rastrearemos duas métricas (número de solicitações de envio relacionadas a ingredientes e número de solicitações de envio de novos colaboradores) mensalmente depois que a documentação for publicada. Também rastrearemos o número de colaboradores que fizeram mais de três contribuições no geral, a partir de trimestre, após a publicação da documentação.
Consideramos o projeto bem-sucedido se, após a publicação da nova documentação:
- O número de solicitações de envio relacionadas a ingredientes aumenta em 20%
- O número de solicitações de envio de novos colaboradores aumenta em 15%
- O número de colaboradores que fizeram > 3 contribuições aumenta 10% (a partir do trimestre após a publicação da documentação)
Cronograma
Quanto tempo você estima que esse trabalho vai levar? Você consegue dividir as tarefas de escritor de tecnologia por mês ou semana?
O projeto em si levará aproximadamente seis meses para ser concluído. Depois que o redator de tecnologia é contratado, passaremos um mês na orientação dele, passaremos para o registro de auditoria e atrito e passaremos os últimos meses focados na criação da documentação.
| Datas | Ações necessárias |
|---|---|
| Maio | Orientações |
| De junho a agosto | Audite a documentação atual e crie registros de atrito |
| Setembro - outubro | Criar documentação |
| Novembro | Conclusão do projeto |
Orçamento do projeto
Diretrizes gerais
- É possível incluir o orçamento na proposta ou como um link separado. Se seu orçamento for menor do que dez itens, recomendamos incluí-lo na proposta.
- Todos os orçamentos devem estar em dólares americanos. Esperamos que as doações variam de US$5.000 a US$15.000. Se seu projeto estiver fora dessa faixa, forneça informações adicionais para justificar seu orçamento.
- Esperamos que a maior parte do seu orçamento (mínimo de 60 a 70%) seja alocada ao redator técnico que trabalha em 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 seu projeto realmente precisar de fundos para suporte ou licenças de software reservado, inclua uma justificativa para o valor.
- Outros gastos possíveis incluem:
- Trabalho de design para criar branding, logotipos, modelos ou outros recursos de design para seu site de documentação
- Valores mínimos (menos de US$200) para brindes do projeto, como camisetas ou adesivos dos participantes. Se você usar o logotipo da temporada de documentos do Google, ele precisará estar acompanhado do logotipo ou nome do projeto ou da organização. Seus brindes não podem usar o nome "Google".
- Prêmios mínimos para voluntários que assumem funções consideráveis de orientação ou orientação no projeto. Recomendamos não mais de US $500 por voluntário.
- As doações downstream para outros projetos de código aberto não devem representar mais de 10% do seu orçamento total.
- Inclua outros itens de orçamento conforme necessário, com a justificativa para o valor buscado. As justificativas de despesas devem destacar como a despesa contribuirá para o sucesso do projeto como um todo.
Orçamento de amostra
| Item de orçamento | Valor | Total acumulado | Observações/justificativas |
|---|---|---|---|
| O redator técnico audita, atualiza, testa e publica a nova documentação do processo de adição de ingredientes para o GloriousPickle | 5.000,00 | 5.000,00 | |
| Subsídios de voluntariado | 500 | 6.500,00 | 3 recompensas por voluntários x 500 cada |
| Camisetas do projeto (10 camisetas) | 150,00 | 6.650,00 | |
| Unicórnio inflável gigante (versão de 4,5 m) | 99,99 | 6.749,99 | Daremos o unicórnio inflável à equipe que responder às perguntas do redator técnico mais rapidamente durante o período de desenvolvimento do projeto. |
| TOTAL | 6.749,99 |
Mais informações
Inclua aqui todas as informações adicionais relevantes para sua proposta.
Experiência anterior com redatores técnicos ou documentação: se você ou qualquer um dos seus mentores já tiver trabalhado com redatores técnicos antes ou desenvolver documentação, mencione isso na inscrição. Descreva a documentação que você produziu e como trabalhou com o redator técnico. Por exemplo, descreva todos os processos de revisão que você usou ou como as habilidades do redator técnico foram úteis para seu projeto. Explique como a experiência anterior pode ajudar você a trabalhar com um redator técnico na Temporada de Documentos do Google.
Participação anterior na Temporada de Documentos do Google, Google Summer of Code ou outros:Se você ou qualquer um dos seus mentores tiver participado 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 maneira como você trabalha na temporada de documentos do Google.