Perguntas frequentes

Fase atual:
desenvolvimento da documentação. Consulte o cronograma.

Geral

A temporada de documentos do Google é um programa de recrutamento?

Não. Se você tem interesse em trabalhar para o Google, visite o site de empregos do Google.

Nossa organização gostaria de participar da temporada de documentos do Google, mas não sabemos por onde começar.

Confira nossa lista completa de ideias de projeto. Você também pode entrar em contato com a comunidade de escrita técnica (experimente o

canal de temporada de documentos

Escreva no Slack ou nos seus canais de mídias sociais para pedir ajuda ou propostas.

Que tipos de projetos as organizações podem propor?

Confira algumas ideias:

  • Criar um site de documentação em uma plataforma a ser decidido pelo redator técnico e pela organização de código aberto e publicar um conjunto inicial de documentos básicos no site. Confira alguns exemplos de plataformas:

  • Refatore a documentação atual do projeto de código aberto para fornecer uma experiência do usuário aprimorada ou uma arquitetura da informação mais acessível.

  • Escreva uma visão geral conceitual ou uma introdução a um produto ou recurso. Muitas vezes, uma equipe cria a documentação técnica de baixo para cima, e o resultado é que há muitos detalhes, mas é difícil entender o produto como um todo. Um redator técnico pode corrigir isso.

  • Crie um tutorial para um caso de uso de alto perfil.

  • Crie um conjunto de guias de instruções para tarefas específicas.

  • Crie um guia do colaborador que inclua informações básicas sobre como começar como colaborador do projeto de código aberto, bem como regras sobre contratos de licença, processos para solicitações de envio e revisões, criação do projeto e assim por diante.

Um vídeo é um projeto possível para a temporada de documentos do Google?

Sim. Verifique se os requisitos de vídeo estão bem definidos e esteja ciente de que a produção de um vídeo de alta qualidade exige tempo e recursos significativos.

Uma auditoria de documentação é um projeto razoável para a temporada de documentos do Google?

Uma auditoria de documentação é um ótimo projeto para a temporada de documentos do Google. Esteja atento à quantidade de documentação que você já tem. Se você tiver muito, talvez seja necessário reduzir o escopo (por exemplo, apenas auditando o conteúdo do tutorial). Se você tem pouca ou nenhuma documentação, inclua a criação da documentação ausente de maior prioridade como parte do seu projeto.

Existem modelos de documentação disponíveis para organizações e redatores técnicos?

A Temporada de Documentos Google tem um repositório do GitHub (em inglês) com um modelo e uma lista de verificação para realizar auditorias de documentação. Outros modelos serão adicionados à medida que forem criados.

O projeto Good Docs (em inglês) está trabalhando para criar alguns modelos de documentação mínimos viáveis para código aberto.

As organizações são obrigadas a usar os documentos produzidos por redatores técnicos?

Não. Ocasionalmente, os projetos não saem como esperado ou os requisitos mudam. Não exigimos que as organizações usem a documentação ou outros materiais produzidos, mas esperamos que a avaliação final e o estudo de caso incluam uma discussão sobre por que a documentação não foi usada e como o projeto tomou a decisão de não usar a documentação ou outros materiais.

Onde ocorre a temporada de documentos do Google?

A temporada de documentos do Google ocorre inteiramente on-line. Não é necessário viajar como parte do programa.

Como posso me manter informado sobre a temporada de documentos do Google?

Acesse a lista de e-mails de avisos em season-of-docs-announce para receber as atualizações e os anúncios mais recentes relacionados à temporada de documentos do Google. Participe do grupo para receber atualizações por e-mail.

Posso adicionar a linha do tempo da Temporada de Documentos Google à minha agenda?

Use http://goo.gle/2NeZVew para se inscrever no calendário da temporada de documentos do Google.

O que posso fazer para ajudar a divulgar a temporada de documentos do Google?

Você pode twittar sobre o programa, escrever postagens de blog, publicar vídeos ou organizar um encontro ou uma sessão de informações na sua área. Temos alguns exemplos de conteúdo e recursos que você pode usar para distribuir à sua comunidade (organização, grupo de autores e outros contatos).

Como posso organizar ou realizar um encontro ou uma sessão informativa sobre a Temporada do Google Docs?

Fique à vontade para agendar um encontro em qualquer horário e local que seja conveniente para você. Consulte as regras do programa e use o conteúdo de amostra.

Você pode compartilhar alguma estatística sobre os programas de 2019 e 2020?

Sim, os resultados da temporada de Documentos Google para o programa 2019 podem ser acessados no blog Googlel Open Source (2019, 2020).

Vou ganhar uma camiseta da temporada de Documentos Google?

Não. Devido a restrições de envio internacional, a temporada de documentos do Google não pode mais fornecer camisetas para os participantes que concluírem o projeto da temporada de documentos do Google.

E se eu tiver mais perguntas?

Confira o guia para administradores da organização e o guia para redator técnico.

Se mesmo depois de ler toda a documentação você ainda não tiver uma resposta, discuta suas dúvidas com a comunidade da temporada de documentos do Google na lista de discussão. Veja as informações sobre canais de discussão e como entrar em contato conosco.

Como faço para ser mentor na temporada de documentos do Google?

A temporada de Documentos Google não tem um papel de mentor formal. As organizações precisam especificar como os redatores técnicos serão integrados e suportados e como as contribuições de documentação deles serão revisadas e aprovadas como parte do aplicativo da organização. Se você estiver interessado em orientar escritores técnicos como parte da temporada de documentos do Google, entre em contato com os administradores da sua organização para se voluntariar.

A temporada de documentos do Google é como o Google Summer of Code?

Não. A Temporada de Documentos do Google é destinada a pessoas com experiência em redação técnica, e não como um programa de mentoria como o Google Summer of Code.

Para redatores técnicos

Quando os redatores técnicos podem se inscrever para a temporada de Documentos do Google?

A temporada de documentos do Google não tem uma inscrição de redator técnico formal. Para participar da Temporada de Documentos Google como redator técnico, entre em contato diretamente com organizações de código aberto, usando as instruções na página do programa Temporada de Documentos Google. Se você tiver interesse, inclua seu nome no Diretório de redatores técnicos da temporada do Google Docs (em inglês). Consulte o guia técnico do gravador para mais informações.

Quais estruturas e ferramentas de documentação eu preciso conhecer para participar da temporada de documentos do Google?

As ferramentas e estruturas de documentação que você usará dependem da organização com que você tem interesse em trabalhar. Parte do objetivo da temporada de documentos do Google é que os projetos de código aberto ajudem escritores técnicos a aprender mais sobre as ferramentas e estruturas envolvidas na documentação de produtos de código aberto. Por esse motivo, geralmente não é necessário ter conhecimento detalhado de plataformas de documentação específicas antes de iniciar seu projeto da temporada de documentos do Google.

Dito isso, a maioria das organizações de código aberto usa alguma variação de Markdown ou outra linguagem de marcação para sua documentação. Recomendamos que você descubra qual linguagem a organização escolhida usa e se familiarize com a sintaxe. Markdown é um bom começo, já que os arquivos README do GitHub usam uma variação do Markdown. Consulte o guia do GitHub para Markdown (em inglês).

Descubra se a organização escolhida já hospeda a documentação em um site e, em caso afirmativo, qual plataforma ela usa. A plataforma pode ser um gerador de sites estáticos, como Jekyll, Sphinx ou Hugo, ou a organização pode hospedar os documentos em Ler os documentos ou páginas do GitHub. Depois de descobrir qual plataforma a organização usa, explore e teste a linguagem e o framework relevantes. Isso ajuda você a começar rapidamente com o projeto de código aberto, além de ser um bom lugar para dar conselhos sobre o projeto de código aberto de sua escolha.

Quais linguagens de programação preciso conhecer para participar dos projetos da temporada de documentos do Google?

Dependendo da natureza do projeto de documentação, talvez seja necessário ter familiaridade com uma linguagem de programação. Tenha isso em mente ao escolher e propor um projeto de documentação e consulte a organização de código aberto sobre o nível de familiaridade necessário.

Os escritores técnicos que já trabalham em um projeto de código aberto podem continuar trabalhando nele como parte da temporada de documentos do Google?

Sim, mas a organização deve anotar a relação anterior ou contínua do redator técnico com o projeto na proposta.

Quais são os requisitos de qualificação para participar?

Preciso de experiência prévia ou treinamento como redator técnico?

De preferência, experiência prévia em escrita técnica ou treinamento, mas não é essencial. Ao enviar uma declaração de interesse para uma organização, você pode descrever sua experiência ou qualquer treinamento que tenha feito em redação técnica. Forneça evidências que mostrem seu interesse em documentação técnica ou de código aberto, incluindo exemplos da documentação que você escreveu. A organização de código aberto procurará escritores técnicos com o nível de experiência que a organização precisa, para garantir a conclusão bem-sucedida dos projetos da temporada de documentos do Google.

Eu receberei por participar da Temporada de Documentos Google?

Sim. O Google concederá benefícios às organizações aceitas para contratar redatores técnicos.

Como é uma boa declaração de interesse de escritor técnico?

As melhores declarações de interesse são de escritores técnicos que dedicam algum tempo para interagir e discutir ideias com a organização de código aberto escolhida antes de enviar as próprias declarações. Consulte o guia sobre como criar sua declaração de interesse.

Quanto tempo leva para participar da temporada de documentos do Google?

Os tamanhos dos projetos variam, mas variam de um compromisso de 5 a 30 horas por semana durante o programa. No entanto, a quantidade de tempo gasta depende da natureza do projeto acordado com sua organização. Antes de confirmar, avalie o projeto e discuta uma estimativa de tempo com a organização de código aberto.

Posso enviar uma inscrição de organização para criar documentação para um projeto de código aberto como pessoa física? Eu gostaria de criar uma série de postagens de blog, vídeos ou outros materiais sobre como usar um projeto ou uma ferramenta de código aberto, mas não faço parte ou colaborador do projeto.

Não, você só deve enviar uma proposta se puder receber fundos em nome do projeto de código aberto. Se você tiver interesse em participar como parte de um projeto, entre em contato com o projeto e colabore em uma proposta de inscrição.

Sou estudante. Posso participar da temporada de Documentos Google? A temporada de documentos do Google me ensinará a ser redator técnico?

Os estudantes estão qualificados para trabalhar com organizações aceitas, mas a temporada de documentos do Google não tem como objetivo ensinar habilidades técnicas de escrita. Os redatores técnicos participantes precisam ter habilidades profissionais de escrita técnica ou experiência relevante equivalente. Os estudantes que quiserem participar precisam destacar a experiência relevante em escrita e edição ao se candidatar.

Posso participar como redator técnico na Season of Docs do Google e como aluno no Google Summer of Code?

Novos colaboradores ou alunos aceitos no Google Summer of Code são desencorajados de se inscrever para ser um redator técnico da temporada de Documentos Google.

A Temporada de Documentos do Google não é destinada a iniciantes, ela é destinada a pessoas que já têm habilidades e experiências sólidas a excelentes de redação técnica. Os redatores técnicos da temporada de documentos do Google não são orientados e, em vez disso, precisam ser auto-organizados e motivados para descobrir o plano para lidar com o projeto da organização com orientação mínima dos administradores da organização e outros membros da comunidade.

Como redator técnico, como posso entrar em contato com os administradores do programa Google Season of Docs do Google se eu tiver outras dúvidas ou preocupações?

Você pode entrar em contato com os administradores do programa Google Season of Docs enviando um e-mail para season-of-docs@google.com.

Uma empresa de redação técnica ou consultoria pode participar da temporada de documentos do Google?

Sim, uma organização pode contratar uma empresa para fazer o trabalho descrito na proposta.

Como faço para mencionar a temporada de documentos do Google no meu currículo?

Liste como faria com qualquer outro trabalho freelance: "Trabalhou como redator técnico do [nome do projeto] como parte do programa Season of Docs do Google".

Você fornece certificados de conclusão por participar da temporada de documentos do Google?

A Temporada de Documentos Google não pode enviar certificados ou confirmações de participação no projeto para redatores técnicos.

Para administradores de organizações de código aberto

Quais são os requisitos de qualificação para uma organização de código aberto?

Para participar como organização, você precisa fazer parte de um grupo que executa um projeto de software ativo sem custo financeiro ou de código aberto, como o BRL-CAD. O projeto não precisa ser uma entidade legalmente incorporada. Para participar do programa, as organizações já precisam ter produzido e lançado software com uma licença aprovada da Iniciativa de código aberto e ter pelo menos dois colaboradores para atuar como administradores da organização em todo o programa Google Season of Docs.

Consulte também os requisitos de qualificação descritos nas regras do programa e os Programas de sanções e informações do país do Tesouro dos EUA.

"organização" é equivalente a um projeto de código aberto?

Uma organização pode ter um ou mais projetos de código aberto. Algumas organizações, como fundações, podem ter várias suborganizações, cada uma com um ou mais projetos de código aberto. Caso sua organização tenha suborganizações independentes, envie inscrições e propostas separadas para cada suborganização.

Uma organização pode enviar mais de uma inscrição de proposta?

Não. Envie apenas uma inscrição por organização. Caso sua organização tenha suborganizações (por exemplo, é uma fundação com muitos projetos individuais de código aberto), cada projeto precisa enviar sua própria inscrição, mesmo que os fundos do subsídio sejam administrados pela organização geral.

Um grupo de projetos de código aberto pode enviar uma proposta em conjunto para trabalhar em um único projeto de documentação?

Uma organização precisa enviar a inscrição da proposta e ser responsável por coordenar o trabalho e o suporte de outros projetos participantes. Por exemplo, um grupo de pequenos projetos de código aberto que são plug-ins para um projeto maior e que quer trabalhar em um guia de instruções conjunto para a criação de plug-ins precisa escolher uma organização para liderar o projeto.

Como minha organização receberá os fundos?

Para receber fundos, sua organização precisa ter uma conta do Open Collective.

As organizações recebem algum dinheiro por participar da temporada de documentos do Google?

As organizações podem incluir fundos para administração, mentoria ou revisão de trabalho como parte dos orçamentos do projeto.

O Google cobre as taxas de processamento de pagamentos?

O Google não cobre as taxas de processamento de pagamentos porque elas variam de acordo com a forma de pagamento. No entanto, o Google não cobre a taxa da plataforma Open Collective e, se você decidir usar o Open Collective como seu host fiscal, essa taxa também será coberta. Consulte o guia para receber concessões para mais informações.

Como minha organização deve orçar o custo de um redator técnico?

Recomendamos consultar a pesquisa Escrever a pesquisa salarial do Documentos e calcular taxas por hora. Você também pode participar do Write The Docs Slack e pedir lances de escritores técnicos interessados no canal #season-of-docs.

Minha organização pode usar a concessão da Temporada de Documentos Google para pagar um colaborador atual?

Sim. No entanto, as propostas de projeto precisam ser para novos trabalhos (incluindo trabalho de manutenção, revisão ou upgrades da documentação existente). Não é possível solicitar uma concessão a ser usada para pagar por um trabalho já concluído.

Minha organização pode trabalhar com redatores técnicos estudantes?

Você pode pedir para os alunos escritores técnicos trabalharem no seu projeto. Se você optar por trabalhar com os alunos, sugerimos que limite a participação a alunos que:

  • têm mais de 18 anos;
  • estão inscritos em um programa ou curso de redação técnica ou comunicação técnica;
  • Ter acesso comprovada à mentoria de redação técnica pelo programa ou curso

Minha organização pode trabalhar com mais de um redator técnico?

Sua organização pode selecionar e pagar mais de um redator técnico, mas todos os escritores técnicos que trabalham com sua organização precisam trabalhar no projeto que você propôs. Trabalhar com vários escritores técnicos aumentará a complexidade do seu projeto e exigirá mais tempo voluntário e de administração.

Minha organização pode contratar uma empresa de redação técnica para trabalhar em nosso projeto?

Sim, sua organização pode contratar uma empresa de redação técnica para trabalhar em seu projeto. Certifique-se de que a empresa que você contrata possa ser paga por meio do Open Collective.

Nosso redator técnico saiu antes do final do programa. Nossa organização ainda está qualificada para receber os fundos restantes?

É altamente recomendável que os projetos tentem encontrar um novo redator técnico para concluir seu projeto antes do final do programa. No entanto, o pagamento dos fundos restantes não é baseado na conclusão do projeto, mas na conclusão do estudo de caso e da avaliação final.

Se o projeto não pôde ser concluído, seu estudo de caso deve examinar o motivo. Por exemplo, talvez você tenha descoberto que suas ferramentas de documentação são muito complicadas e provou ser uma barreira para integrar um redator técnico ou que seu projeto envolveu testes e atualizações de tutoriais e exigiu ampla experiência em codificação. O que você recomendaria a outros projetos, com base na sua experiência? Inclua essas informações em seu estudo de caso.

A inscrição de uma organização pode ser analisada antes do prazo final?

Infelizmente, a Temporada de Documentos Google não pode fornecer feedback sobre o aplicativo da organização.

Como as organizações precisam definir o escopo das propostas de projetos?

Ao desenvolver ideias de projetos, tente encontrar os menores projetos que agregarão valor à organização (mas podem ser expandidos se o tempo permitir). Menor é melhor. Ao criar sua proposta de projeto, recomendamos se ater a projetos menores e mais detalhados em vez de projetos maiores, menos especificados. Se o projeto requer muita experiência em domínio, tente incluir projetos que possam ser trabalhados por alguém sem esse histórico.

Posso participar como administrador da organização na Temporada de Documentos Google e como mentor no Google Summer of Code?

Sim. O Google Season of Docs e o Google Summer of Code são programas separados. Se você tiver largura de banda para participar dos dois programas, tudo bem.

Nossa organização participou dos programas da temporada anterior de Documentos Google. Nossa organização pode se inscrever de novo?

Sim, as organizações que participaram dos programas da temporada anterior de Documentos Google podem se inscrever de novo.

Dados arquivados

Como faço para remover minhas informações do arquivo da temporada de documentos do Google?

Entre em contato para remover suas informações.