Guia do administrador da organização

Fase atual:
Resultados anunciados da linha do tempo.

Este guia é destinado a administradores de organizações que estejam se inscrevendo ou participando do programa da temporada de documentos.

Sua organização deve participar do programa Temporada de Documentos?

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?
• Tem membros da comunidade dispostos a ajudar a recrutar, avaliar e integrar um redator técnico 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)?
• Ter 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, além da avaliação final e do 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 Temporada de Documentos.

Além disso, a organização precisa atender aos requisitos de qualificação do programa, além de poder criar uma conta do Open Collective.

O processo de candidatura para organizações

Fase de exploração

As inscrições para a temporada de Documentos Google começam em 23 de fevereiro de 2022, 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. Ela inclui uma lista das principais necessidades, metas ou problemas, possíveis soluções de documentação e possíveis métricas. Ela 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 podem fazer perguntas, expressar interesse ou 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. 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 do projeto para ver exemplos.
• Divulgue a página de proposta nos canais da comunidade e adicione sua organização à lista de organizações interessadas no repositório da Season of Docs do GitHub (em inglês). Também convém compartilhar seu link no canal #season-of-docs no Slack para escrever documentos. 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 escritor técnico precisaria para trabalhar com sucesso com sua comunidade e organização. Quais habilidades sua comunidade seria capaz de ajudar um escritor técnico a desenvolver (por exemplo, usando o 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 de redatores técnicos interessados.
• Começar a revisar todas as declarações de interesse enviadas de redatores 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 apenas uma proposta. Alguns pontos a serem considerados:
  • Qual ideia recebeu mais interesse dos redatores 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 tenha mais chances de ser concluído, mas que 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. Entenda e inclua:

  • O problema que você quer resolver
  • O escopo da documentação que você quer melhorar ou criar
  • Como você vai medir o sucesso de 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é 25 de março de 2022, às 18h (UTC). As propostas aceitas serão anunciadas em 14 de abril de 2022.

Desenvolvimento e relatórios de projetos

Lançamento do projeto

• Se sua organização já tiver selecionado um redator técnico para o projeto, faça uma reunião inicial com ele. Colabore 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 sua seleção ou informe os candidatos sobre sua decisão.

Pagamentos da concessão

• A partir de 9 de junho de 2022, a Season of Docs depositará 40% dos fundos 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 serão 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 14 de dezembro de 2022. Observe que todos os projetos bem-sucedidos, independentemente do cronograma de conclusão (por exemplo, projeto de três ou seis meses), vão começar a receber o pagamento final em 14 de dezembro de 2022.
• 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 o recebimento do 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

As organizações precisam concluir e enviar a avaliação final do projeto e o estudo de caso até 30 de novembro de 2022, às 18h (UTC), para receber os fundos restantes.

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 2022, às 18h (UTC).

Estudo de caso

O estudo de caso da temporada de documentos é o principal resultado da participação da sua organização na temporada de documentos. Manter um registro semanal de atualizações do projeto ajudará você a criar seu estudo de caso. Para cada semana, registre o andamento do projeto (incluindo links para solicitações de envio, problemas ou conversas, quando útil), o que deu certo (ou não), as coisas 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 criar seu estudo de caso. 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. Lembre-se disso 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
Inscrição da organização	As inscrições da organização foram encerradas. Inscreva-se na lista de e-mails de anúncios em season-of-docs-announce para ficar por dentro de tudo.	25 de março de 2022, às 18h (UTC)
Informações de pagamento da organização	Este formulário ainda não está disponível.	12 de maio de 2022, às 18h (UTC)
Comprovante de contratação de redator técnico	A fase de contratação do redator técnico foi concluída.	16 de maio de 2022, às 18h (UTC)
Avaliações mensais	A fase de avaliação mensal foi encerrada.	Consulte a linha do tempo
Avaliação final do projeto e estudo de caso	A fase de avaliação do projeto foi encerrada.	30 de novembro de 2022, às 18h UTC
Pesquisas de acompanhamento	Formulário disponível durante a fase de pesquisas de acompanhamento (2 de maio de 2023).	Consulte a linha do tempo

Informações relacionadas

• Consulte o cronograma da temporada de documentos.