Fase atual:
Resultados anunciados
da linha do tempo.
Use este guia como modelo para criar uma proposta de projeto para 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 o guia de estilo” é muito longo.
Sobre sua organização
Nesta seção, conte sobre sua organização ou projeto em alguns parágrafos curtos. Que problema o 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 possível 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 na logística de grandes empresas e organizações de processamento de alimentos. Nosso maior usuário é uma organização que ajuda os bancos de alimentos a transformar vegetais de curta duração 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 vai 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ária não europeia) à 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 completamente). 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 de ingredientes tivermos, mais útil o GloriousPickle será para todos os nossos usuários.
Escopo do projeto
Conte qual documentação 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 o projeto.
O projeto GloriousPickle (conhecido com o codinome PicklePlus) irá:
- Audite a documentação 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 um guia para entender as lacunas na documentação e crie uma documentação atualizada para os principais casos de uso.
- Crie uma "folha de referência" rápida para ajudar os colaboradores novos a extrair solicitações e o GitHub a fim de ajudá-los a usar nosso processo.
- Incorpore o feedback dos testadores da documentação (voluntários no projeto) e da comunidade GloriousPickle mais ampla.
- Trabalhe com a equipe de lançamento para atualizar a documentação no site do GloriousPickle e crie um processo para manter a documentação sincronizada com a ferramenta de atualização.
Trabalho que está fora do escopo para este projeto:
- Este projeto não criará um processo de vinculação cruzada entre grafias ou nomes diferentes para o mesmo ingrediente.
- Este projeto não criará nenhum tutorial do GitHub. Em vez disso, a folha de referência terá links para materiais relevantes e úteis.
Temos dois candidatos competentes de redação técnica para este projeto e estimamos que ele levará três meses para ser concluído. O SIG do GloriousPickle PickleDocs e o @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 o problema? Quais métricas você usará e como elas serão monitoradas?
O GloriousPickle recebe uma média de dez solicitações de envio por trimestre para adicionar ou atualizar novos ingredientes (marcados como "ingrediente"). A maioria dessas solicitações de envio (> 60%) é de colaboradores anteriores. Acreditamos que essa documentação aprimorada resultará em mais solicitações de envio e 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 colaboradores mais ativos em geral.
Rastrear duas métricas (número de solicitações de envio relacionadas a ingredientes e de novos colaboradores) mensalmente após a publicação da documentação. Também acompanharemos 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 em 10% (a partir do trimestre após a publicação da documentação)
Cronograma
Quanto tempo você estima que esse trabalho levará? Você consegue detalhar as tarefas de redator de tecnologia por mês/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 concentrando-se na criação da documentação.
| Datas | Itens de ação |
|---|---|
| Maio | Orientações |
| De junho a agosto | Audite a documentação atual e crie um registro 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 em sua proposta.
- Todos os orçamentos devem estar em dólares americanos. Esperamos que os subsídios variem 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 fazer o orçamento 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 realmente precisar de fundos para licenças ou suporte de software reservado, 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ê usa o logotipo da temporada de documentos, ele precisa vir acompanhado do logotipo ou nome do seu projeto ou organização. Os brindes não podem usar o nome "Google".
- Gastos mínimos para voluntários que assumem funções consideráveis de mentoria ou orientação no projeto (recomendamos no máximo US $500 por voluntário, por favor)
- As doações downstream para outros projetos de código aberto não devem ultrapassar 10% do seu orçamento total.
- Inclua outros itens de orçamento conforme necessário, além da justificativa para o valor buscado. As justificativas de despesas devem destacar como as despesas contribuirão para o sucesso do projeto como um todo.
Orçamento de amostra
| Item de orçamento | Valor | Total acumulado | Observações/justificações |
|---|---|---|---|
| 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 voluntários | 500 | 6500.00 | 3 salários para 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 o mais rápido possível durante o período de desenvolvimento do projeto. |
| TOTAL | 6.749,99 |
Mais informações
Inclua aqui qualquer informação adicional relevante para sua proposta.
Experiência anterior com redatores técnicos ou documentação: se você ou qualquer um de seus mentores já trabalhou com redatores técnicos ou desenvolveu documentação, mencione isso na inscrição. Descreva a documentação que você produziu e como você 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 o projeto. Explique como essa experiência anterior pode ajudar você a trabalhar com um redator técnico na Temporada de Documentos.
Participação anterior na Season of Docs, 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 inscrição. Descreva suas conquistas nesse programa. Explique como essa experiência pode influenciar a maneira como você trabalha na temporada de documentos.