Fase atual:
desenvolvimento da documentação. Consulte o
cronograma.
Este guia é destinado a administradores de organizações que estão se inscrevendo ou participando do programa Season of Docs do Google.
A sua organização deve participar do programa Temporada de Documentos Google?
Use estas perguntas para entender se a sua organização ou projeto de código aberto precisa participar da temporada de documentos do Google.
Sua organização ou projeto:
- Você acredita que uma documentação nova ou atualizada ajudaria a alcançar um objetivo ou resolver um problema no seu projeto ou comunidade?
- Tem uma compreensão inicial ou uma hipótese de como você mediria o sucesso do seu projeto de documentação?
- Os membros da comunidade estão dispostos a ajudar a recrutar, avaliar e integrar redatores técnicos, e quem estaria disponível para responder a perguntas e fornecer outro suporte durante o projeto (6 a 8 meses, incluindo o período de inscrição)?
- Tem um membro da comunidade disposto a atuar como administrador da organização e coordenar a criação da inscrição, responder às perguntas dos administradores do programa e enviar avaliações mensais, a avaliação final e o estudo de caso? O administrador da organização também deve estar disposto a responder a pesquisas de acompanhamento após a conclusão do programa Google Season of Docs.
Sua organização também precisa atender aos requisitos de qualificação do programa, incluindo a capacidade de criar uma conta do Open Collective.
O processo de inscrição da organização
Fase de exploração
As inscrições para a temporada de documentos do Google estão abertas em 22 de fevereiro de 2024, mas sugerimos que as organizações reservem um tempo para concluir as etapas da fase de análise detalhada antes de enviar a inscrição.
- Criar uma página de proposta de projeto. Ela inclui uma lista das principais necessidades, metas ou problemas, possíveis soluções de documentação e possíveis métricas. A página precisa ser pública e permitir contribuições e discussões da comunidade. Inclua informações para redatores técnicos que gostariam de participar: onde eles deveriam fazer perguntas, expressar interesse ou ir aprender mais sobre seu projeto? Sugerimos adicionar um endereço de e-mail para entrar em contato com sua organização de código aberto sobre a temporada de documentos do Google. No entanto, recomendamos que você não use um endereço de e-mail pessoal como endereço de e-mail para entrar em contato com sua organização de código aberto. Consulte a lista de ideias de projetos para ver exemplos.
- Divulgue a página da proposta nos canais da comunidade e adicione sua organização à lista de organizações interessadas no repositório GitHub da temporada de documentos do Google (em inglês). Você também pode compartilhar seu link no canal #season-of-docs no Write The Docs Slack. A página de promoção e imprensa inclui logotipos e outros conteúdos que você pode usar quando falar sobre a temporada de documentos do Google.
- Para cada ideia de documentação, considere que experiência e qualificações um redator técnico precisaria para trabalhar com sucesso com sua comunidade e organização. Quais habilidades sua comunidade poderia ajudar um redator técnico a desenvolver (por exemplo, usando GitHub ou seu conjunto de ferramentas de documentos)? Consulte o guia para trabalhar com redatores técnicos.
- Peça voluntários para ajudar a responder a perguntas dos redatores técnicos interessados.
- Comece analisando todas as declarações de interesse enviadas por escritores técnicos interessados em trabalhar com seu projeto.
Fase de aplicação
- Escolha a ideia mais promissora na página da proposta. Cada organização
pode enviar somente uma proposta. Alguns pontos a serem considerados:
- Qual ideia recebeu mais interesse dos escritores técnicos?
- Qual ideia ajudará a resolver o maior problema do seu projeto? É melhor escolher uma ideia mais arriscada que tenha um impacto maior do que uma ideia para um projeto de documentação que tenha mais chances de ser concluído, mas não fará uma diferença significativa no projeto.
- A ideia requer a participação de membros específicos da sua comunidade? Eles têm tempo para participar?
Crie sua proposta usando o modelo de proposta. Certifique-se de entender e incluir:
- O problema que você quer resolver
- O escopo da documentação que você deseja melhorar ou criar
- Como você vai medir o sucesso da sua documentação
Sua proposta também precisa incluir um orçamento. Propostas incompletas não podem ser consideradas.
Envie o formulário de inscrição até o prazo de inscrição:2 de abril de 2024, às 18h UTC. As propostas aceitas serão anunciadas em 10 de abril de 2024.
Desenvolvimento e relatórios de projetos
Lançamento do projeto
- Se sua organização já tiver selecionado um redator técnico ou redatores para o projeto, faça uma reunião inicial com ele. Você deve colaborar com seu redator técnico para criar um cronograma para o trabalho e verificações regulares.
- Se você recebeu várias declarações de interesse de redatores técnicos interessados, faça um anúncio público sobre a seleção de redator técnico ou informe de outra forma os candidatos sobre sua decisão.
Permitir pagamentos
- A partir de 11 de junho de 2024, o Google Season of Docs depositará 40% dos fundos da concessão na conta do Open Collective de cada organização após a contratação de um redator técnico. Recomendamos que as organizações criem um cronograma de pagamento com os redatores técnicos com base nos marcos do projeto, incluindo um pagamento no início do projeto.
- Os 60% restantes vão ser depositados nas contas do Open Collective de organizações que concluírem e enviarem as avaliações finais e estudos de caso, a partir de 13 de dezembro de 2024. Todos os projetos bem-sucedidos vão começar a receber o pagamento final em 13 de dezembro de 2024
- Consulte o guia de pagamentos para mais informações sobre como criar uma conta do Open Collective.
Relatórios de status de projeto
- Os administradores da organização precisam preencher os relatórios de status mensais até uma semana após receber o link para o formulário do relatório de status. O link será enviado por e-mail, então verifique sua caixa de spam caso não tenha recebido.
Avaliação final do projeto e estudo de caso
Para receber os fundos de subsídio restantes, as organizações precisam concluir e enviar a avaliação final do projeto e o estudo de caso antes de 10 de dezembro de 2024, às 18h (UTC).
Avaliação final
O formulário de avaliação final será disponibilizado aos administradores da organização pelo menos um mês antes de 10 de dezembro de 2024, às 18h (UTC).
Estudo de caso
O estudo de caso da Temporada de Documentos Google é o principal resultado da participação da sua organização na Temporada de Documentos Google. Manter um registro semanal de atualizações do projeto ajudará você a criar seu estudo de caso. Para cada semana, registre o progresso do projeto (incluindo links para solicitações de envio, problemas ou conversas, quando útil), o que deu certo (ou não), o que você aprendeu e as perguntas que foram feitas.
Leia como criar um estudo de caso para mais informações e siga nosso modelo de estudo de caso para criá-lo. Você enviará seu estudo de caso como um link no formulário de avaliação final.
Seu estudo de caso será publicado no site Google Season of Docs. Lembre-se disso ao incluir informações sobre seu projeto.
As organizações aceitas precisam participar de pelo menos três pesquisas de acompanhamento para ajudar a acompanhar o sucesso dos projetos da temporada de documentos do Google ao longo do tempo.
Formulários
| Forma | Link | Prazo |
|---|---|---|
| Aplicativo da organização | Os aplicativos da organização foram fechados. Inscreva-se na lista de e-mails de avisos em season-of-docs-announce para ficar por dentro. |
2 de abril de 2024, às 18h (UTC) |
| Informações de pagamento da organização | 14 de maio de 2024, às 18h (UTC) | |
| Comprovante de contratação de escritor técnico | 22 de maio de 2024, às 18h (UTC) | |
| Avaliações mensais | Formulário disponível durante a fase de avaliação do projeto (5 de junho de 2024). |
Consulte o cronograma |
| Avaliação final do projeto e estudo de caso | Formulário disponível durante a fase final de avaliação do projeto e estudo de caso (22 de novembro de 2024 a 10 de dezembro de 2024). |
10 de dezembro de 2024, às 18h UTC |
| Pesquisas de acompanhamento | Formulário disponível durante a fase de pesquisas de acompanhamento (1o de maio de 2025). |
Consulte o cronograma |
Informações relacionadas
- Consulte o cronograma da temporada de Documentos Google.