Guia do administrador da organização

Fase atual:
O programa "Season of Docs" de 2021 terminou em 14 de dezembro de 2021. Consulte linha do tempo.

Este guia é destinado a administradores de organizações que se inscreveram ou estão participando do programa Google Season of Docs de 2021.

Sua organização deve participar do programa Google Season of Docs de 2021?

Use essas perguntas para entender se seu projeto ou organização de código aberto deve 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 uma meta ou resolver um problema no seu projeto ou comunidade?
  • Você tem uma compreensão inicial ou uma hipótese de como mediria o sucesso do seu projeto de documentação?
  • Há membros da comunidade dispostos a ajudar a recrutar, avaliar e integrar um redator técnico e que estejam disponíveis para responder a perguntas e oferecer outro suporte durante o projeto (6 a 8 meses, incluindo o período de inscrição)?
  • Um membro da comunidade está disposto a ser o administrador da organização e coordenar a criação do aplicativo, 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 responder a pesquisas de acompanhamento após a conclusão da Temporada de documentos do Google de 2021.

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

Embora as inscrições para a Temporada de Documentos do Google de 2021 sejam abertas em 9 de fevereiro de 2021, recomendamos que as organizações concluam as etapas da fase de exploração antes de enviar a inscrição.

  • Crie uma página de proposta de projeto. A página da proposta inclui uma lista de principais necessidades, metas ou problemas, possíveis soluções de documentação e possíveis métricas. Essa página precisa ser pública e permitir a contribuição e discussão da comunidade. Inclua informações para redatores técnicos que gostariam de participar: onde eles podem fazer perguntas, expressar interesse ou saber mais sobre seu projeto? Confira a lista de ideias de projetos para ver exemplos.
  • Divulgue a página da proposta nos canais da sua comunidade e adicione sua organização à lista de organizações interessadas no repositório do GitHub da Google Season of Docs. Você também pode compartilhar seu link no canal #season-of-docs no Slack do Write The Docs. A página de divulgação e imprensa inclui logotipos e outros conteúdos que você pode usar ao falar sobre a Temporada de documentos do Google.
  • Para cada ideia de documentação, considere a experiência e as qualificações que um redator técnico precisa ter para trabalhar com sucesso na sua comunidade e organização. Quais habilidades sua comunidade poderia ajudar um redator técnico a desenvolver (por exemplo, usando o GitHub ou a ferramenta de documentação)? Consulte o guia para trabalhar com redatores técnicos.
  • Peça voluntários para ajudar a responder às perguntas dos redatores técnicos interessados.
  • Comece a analisar as declarações de interesse enviadas por redatores técnicos interessados em trabalhar com seu projeto.

Fase de inscrição

  • Escolha a ideia mais promissora da sua página de proposta. Cada organização pode enviar apenas uma proposta. Algumas coisas a considerar:
    • Qual ideia recebeu mais interesse dos redatores técnicos?
    • Qual ideia vai 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 chances de ser concluído, mas não faria uma diferença significativa no seu projeto.
    • A ideia exige 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 da sua documentação

    Sua proposta também precisa incluir um orçamento. Propostas incompletas não serão consideradas.

  • Envie o formulário de inscrição até o prazo de 26 de março de 2021, às 18h (UTC). As propostas aceitas serão anunciadas em 16 de abril de 2021.

Desenvolvimento de projetos e relatórios

Início do projeto

  • Se a sua organização já tiver selecionado um ou mais redatores técnicos para o projeto, faça uma reunião de início com o redator técnico. Você precisa colaborar com o redator técnico para criar uma programação do trabalho e fazer verificações regulares.
  • Se você receber várias declarações de interesse de escritores técnicos interessados, faça um anúncio público da sua seleção ou informe os candidatos sobre sua decisão.

Pagamentos de subsídio

  • O Google Season of Docs vai depositar 40% dos fundos do prêmio na conta do Open Collective de cada organização depois que ela contratar um redator técnico, a partir de 10 de junho de 2021. Recomendamos que as organizações criem um cronograma de pagamento com redatores técnicos com base em marcos do projeto, incluindo um pagamento no início do projeto.
  • Os 60% restantes serão depositados nas contas do Open Collective das organizações que concluírem e enviarem as avaliações finais e 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 do projeto

  • Os administradores da organização precisam preencher os relatórios de status mensais em até uma semana após receber o link para o formulário de relatório de status (o link será enviado por e-mail. 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 2021, às 18h (UTC), para receber o restante dos fundos do programa.

Avaliação final

O formulário de avaliação final vai ficar disponível para os administradores da organização pelo menos um mês antes de 30 de novembro de 2021, às 18h UTC.

Estudo de caso

O estudo de caso do Google Season of Docs é o principal resultado da participação da sua organização no Google Season of Docs 2021. Manter um registro semanal das atualizações do projeto vai ajudar você a criar seu estudo de caso. Para cada semana, registre o progresso do projeto (incluindo links para solicitações de pull, problemas ou conversas, quando útil), o que correu bem (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 criar o seu. Você vai enviar seu estudo de caso como um link no formulário de avaliação final.

Seu estudo de caso será publicado no site do Google Season of Docs. Portanto, considere essa informação ao incluir informações sobre seu projeto.

As organizações precisam participar de pelo menos três pesquisas de acompanhamento para nos ajudar a acompanhar o sucesso dos projetos do Google Season of Docs ao longo do tempo.

Formulários

Formulário Link Prazo
Solicitação de organização

As inscrições para organizações estão encerradas. Participe da lista de e-mails de anúncios em season-of-docs-announce para ficar por dentro de tudo.

 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.

 12 de maio de 2021, às 18h (UTC)
Comprovante de contratação de redator técnico

Fase de contratação de redatores técnicos concluída.

 17 de maio de 2021, às 18h (UTC)
Avaliações mensais

A fase de avaliação mensal foi encerrada.

 Conferir a linha do tempo
Avaliação final do projeto e estudo de caso

Formulário de avaliação do programa

 30 de novembro de 2021, às 18h (UTC)
Pesquisas de acompanhamento

Formulário disponível durante a fase de pesquisas de acompanhamento (1º de maio de 2025).

 Conferir a linha do tempo