Fase atual:
a temporada de 2021 do programa Documentos foi encerrada em 14 de dezembro de 2021. Consulte o
cronograma.
Este guia é destinado a administradores de organizações que estejam se inscrevendo ou participando do programa Documentos Google 2021.
Sua organização deve participar do programa Season of Docs 2021?
Use estas perguntas para entender se a sua organização ou projeto de código aberto deve participar da Temporada de Documentos.
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 precisa estar disposto a responder a pesquisas de acompanhamento após a conclusão da temporada de 2021 de Documentos Google.
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 2021 dos Documentos Google devem começar em 9 de fevereiro de 2021, mas sugerimos que as organizações reservem um tempo para concluir as etapas da fase de Análises detalhadas antes de enviar a inscrição.
- Criar uma página de proposta de projeto. A página da proposta inclui uma lista das principais necessidades, metas ou problemas, possíveis soluções de documentação e possíveis métricas. Esta página deve 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 saber mais sobre seu projeto? Veja exemplos na lista de ideias de projetos.
- 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 ao falar sobre a temporada de documentos.
- 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 teria um impacto maior do que uma ideia para um projeto de documentação que tem mais probabilidade de ser concluído, mas não fará uma diferença significativa no seu 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 são consideradas.
Envie o formulário de inscrição até as 18h (UTC) até 26 de março de 2021. As propostas aceitas serão anunciadas em 16 de abril de 2021.
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 10 de junho de 2021, a Temporada de Documentos depositará 40% dos fundos da concessão na conta da 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 serão depositados nas contas do Open Collective de organizações que concluírem e enviarem as avaliações finais e os estudos de caso, a partir de 14 de dezembro de 2021.
- 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 devem preencher os relatórios de status mensais dentro de uma semana após receber o link para o formulário de relatório de status (o link será enviado por e-mail, portanto, verifique sua caixa de spam).
Avaliação final do projeto e estudo de caso
Para receber os fundos restantes, as organizações precisam concluir e enviar a avaliação final do projeto e o estudo de caso até as 18h (UTC) do dia 30 de novembro de 2021.
Avaliação final
O formulário de avaliação final será disponibilizado aos administradores da organização até um mês antes de 30 de novembro de 2021, às 18h (UTC).
Estudo de caso
O estudo de caso da temporada de documentos do Google é o principal resultado da participação da sua organização na temporada de documentos de 2021. 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 o artigo 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 Season of Docs, portanto, tenha isso em mente ao incluir informações sobre seu projeto.
Exigimos que as organizações participem de pelo menos três pesquisas de acompanhamento para nos ajudar a acompanhar o sucesso dos projetos da Temporada de Documentos ao longo do tempo.
Formulários
| Formulário | 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. |
26 de março de 2021 às 18h UTC |
| Informações de pagamento da organização | Fase de informações de pagamento da organização concluída. Se você precisar fazer mudanças nas informações de pagamento da sua organização, entre em contato com os administradores da temporada de Documentos Google. |
12 de maio de 2021 às 18h UTC |
| Comprovante de contratação de escritor técnico | Fase de contratação de redator técnico concluída. |
17 de maio de 2021 às 18h UTC |
| Avaliações mensais | 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). |
30 de novembro de 2021, à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 a linha do tempo da temporada de Documentos.