Perguntas frequentes

Fase atual:
O programa "Temporada de documentos" de 2021 terminou em 14 de dezembro de 2021. Consulte linha do tempo.

Geral

A Season of Docs do Google é um programa de recrutamento?

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

Quais são as mudanças da Temporada de documentos do Google em 2021?

A Temporada de Documentos do Google de 2021 tem mudanças significativas em relação aos anos anteriores, incluindo:

  • Os redatores técnicos não precisam mais se inscrever no Google para serem encontrados por organizações.
  • As organizações enviam propostas de projeto como parte da inscrição, incluindo um orçamento e métricas propostas
  • As organizações aceitas recebem subsídios, que são usados para pagar redatores técnicos
  • As organizações enviam avaliações finais e estudos de caso

Por que o Google Season of Docs fez essas mudanças?

A missão do Google é organizar as informações do mundo todo e torná-las universalmente acessíveis e úteis. Ao redirecionar a Google Season of Docs para enfatizar o aprendizado sobre práticas eficazes de documentação em código aberto, esperamos ter um impacto maior a longo prazo.

Nossa organização quer participar da Temporada de documentos de 2021, mas não sabemos por onde começar.

Confira nossa lista completa de ideias de projetos. Você também pode entrar em contato com a comunidade de redação técnica (tente o canal #season-of-docs no Write the Docs Slack ou nos seus canais de mídia social para pedir ajuda ou fazer propostas).

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

Veja algumas ideias:

  • Crie um site de documentação em uma plataforma a ser decidida pelo redator técnico e pela organização de código aberto e publique um conjunto inicial de documentos básicos no site. Exemplos de plataformas:

  • Refactorizar a documentação atual do projeto de código aberto para oferecer uma experiência do usuário melhor ou uma arquitetura de informações mais acessível.

  • Escreva uma visão geral conceitual ou introdução de um produto ou recurso. Muitas vezes, uma equipe cria a documentação técnica de baixo para cima, resultando em 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 práticos específicos para tarefas específicas.

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

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

Sim. Confira se os requisitos de vídeo estão bem definidos e tenha em mente 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. Tenha cuidado com a quantidade de documentação que você já tem. Se tiver muita, talvez seja necessário reduzir o escopo (por exemplo, apenas auditando o conteúdo do tutorial). Se você tiver pouca ou nenhuma documentação, inclua a criação da documentação de maior prioridade como parte do seu projeto.

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

O Google Season of Docs tem um repositório do GitHub com um modelo e uma lista de verificação para realizar auditorias de documentação. Esperamos adicionar outros modelos conforme eles forem criados.

O Good Docs Project está trabalhando para criar alguns modelos de documentação viáveis mínimos para código aberto.

As organizações precisam usar os documentos produzidos por redatores técnicos?

Não. Às vezes, 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?

O Google Season of Docs acontece totalmente on-line. Não é necessário viajar como parte do programa.

Como posso ficar por dentro das novidades do Google Season of Docs?

Acesse a lista de e-mails de comunicados em season-of-docs-announce para conferir as atualizações e os comunicados 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?

Sim, é possível adicionar usando este link.

O que posso fazer para ajudar a divulgar o Google Season of Docs?

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

Como organizar ou hospedar uma sessão de informações ou um evento do Google Season of Docs?

Você pode agendar um encontro no horário e local mais conveniente para você. Leia as regras do programa e use o conteúdo de exemplo.

Você pode compartilhar algumas estatísticas sobre as temporadas de 2019 e 2020 dos Docs?

Sim, os resultados do Google Season of Docs para o programa de 2019 podem ser conferidos aqui e os resultados do programa de 2020 podem ser conferidos aqui.

Vou receber uma camiseta do Google Season of Docs?

Não, devido a restrições de envio internacional, não será mais possível fornecer camisetas para os participantes que concluírem o projeto da Temporada de documentação do Google.

E se eu tiver mais perguntas?

Consulte o guia para administradores da organização e o guia para redatores técnicos.

Se, depois de ler toda a documentação, você ainda não tiver uma resposta, discuta suas perguntas com a comunidade do Google Season of Docs na lista de discussão. Confira as informações sobre canais de discussão e como entrar em contato com a gente.

Como posso ser mentor do Google Season of Docs?

A Temporada de documentos do Google de 2021 não tem um papel formal de mentor. As organizações precisam especificar como os redatores técnicos serão integrados e receberão suporte e como as contribuições de documentação serão analisadas e aprovadas como parte do aplicativo da organização. Se você tem interesse em ser mentor de redatores técnicos como parte do Google Season of Docs, recomendamos que você trabalhe com os administradores da sua organização para se voluntariar.

A Season of Docs é como o Google Summer of Code?

Não. O Google Season of Docs é destinado a pessoas com alguma experiência em escrita técnica, não é um programa de mentoria como o Google Summer of Code.

Para redatores técnicos

Quando os redatores técnicos podem se inscrever na Temporada de documentos do Google?

A Temporada de documentos do Google de 2021 não tem uma inscrição formal de redator técnico. Para participar da Temporada de documentos do Google de 2021 como redator técnico, entre em contato diretamente com as organizações de código aberto, usando as instruções na página do programa da Temporada de documentos. Você também pode expressar seu interesse adicionando seu nome ao diretório de redatores técnicos da Season of Docs. Consulte o guia do redator técnico para mais informações.

Quais ferramentas e frameworks de documentação devo conhecer para participar da Temporada de documentos do Google?

As ferramentas e os frameworks de documentação que você vai usar dependem da organização com que você quer trabalhar. Parte do objetivo da Google Season of Docs é que os projetos de código aberto ajudem os redatores técnicos a aprender mais sobre as ferramentas e os frameworks envolvidos 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 do Google Season of Docs.

No entanto, a maioria das organizações de código aberto usa algum tipo de Markdown ou outra linguagem de marcação para a documentação. Recomendamos que você descubra qual linguagem a organização escolhida usa e se familiarize com a sintaxe. O Markdown é um bom começo, já que os arquivos README do GitHub usam uma versão dele. Consulte o guia do GitHub sobre Markdown.

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 no Read the Docs ou nas GitHub Pages. 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 seu projeto de código aberto e coloca você em uma boa posição para dar conselhos sólidos ao 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 conhecer 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 redatores técnicos que já estão trabalhando em um projeto de código aberto podem continuar trabalhando nele como parte da Temporada de documentos do Google?

Sim, mas a organização precisa indicar a relação anterior ou atual do redator técnico com o projeto na proposta.

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

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

Experiência ou treinamento anterior em redação técnica é preferível, mas não essencial. Ao enviar uma declaração de interesse a uma organização, você pode descrever sua experiência e/ou treinamento em redação técnica. Você precisa fornecer algumas evidências que mostrem seu interesse em documentação técnica ou de código aberto, incluindo exemplos de documentação que você escreveu. A organização de código aberto vai procurar redatores técnicos com o nível de experiência necessário para garantir a conclusão dos projetos do Google Season of Docs.

Vou receber algum pagamento por participar do Google Season of Docs?

Sim. O Google vai oferecer bolsas para as organizações aceitas usarem para contratar escritores técnicos.

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

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

Quanto tempo leva para participar do Google Season of Docs?

O tamanho dos projetos varia, mas varia de um compromisso de 5 a 30 horas por semana durante o programa. No entanto, o tempo que você gasta depende da natureza do projeto acordado com sua organização. Antes de se comprometer, avalie o projeto e discuta uma estimativa de tempo com a organização de código aberto.

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

Não, só envie uma proposta se você puder receber fundos em nome do projeto de código aberto. Recomendamos que você entre em contato com o projeto e colabore em uma proposta de aplicativo.

Sou estudante. Posso participar da Temporada de documentos do Google em 2021? O Google Season of Docs vai me ensinar a ser um redator técnico?

Os estudantes podem trabalhar com organizações aceitas, mas o Google Season of Docs não tem como objetivo ensinar habilidades de redação técnica. Esperamos que os redatores técnicos participantes tenham habilidades profissionais de redação técnica ou experiência relevante equivalente. Os estudantes que quiserem participar devem destacar sua experiência relevante em escrita e edição ao entrar em contato com organizações e projetos interessados.

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

Embora isso não seja contra as regras no momento, sugerimos que os estudantes aceitos no Google Summer of Code não se inscrevam para ser redatores técnicos do Google Season of Docs. Os estudantes precisam se concentrar no trabalho do Google Summer of Code, em vez de se inscrever no Google Season of Docs.

Além disso, o Google Season of Docs não é destinado a iniciantes, mas a pessoas que já têm experiência e habilidades técnicas de escrita sólidas. Os redatores técnicos do Season of Docs não recebem orientação, e precisam se organizar e se motivar para descobrir o plano de abordagem do 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 se tiver outras dúvidas ou preocupações?

Entre em contato com os administradores do programa Google Season of Docs por e-mail season-of-docs@google.com.

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

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

Como faço para citar o Season of Docs no meu currículo?

Liste-o como faria com qualquer outro trabalho freelance, por exemplo, "Trabalhei como redator técnico para [nome do projeto] como parte do programa Season of Docs".

Vocês oferecem certificados de conclusão para quem participa da Temporada dos Documentos?

Não é possível 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 ser um grupo que executa um projeto de software sem custo financeiro/de código aberto ativo, como o BRL-CAD. O projeto não precisa ser uma entidade legalmente incorporada. As organizações precisam ter já produzido e lançado um software com uma licença aprovada pela Open Source Initiative e ter pelo menos dois colaboradores para atuar como administradores da organização em toda a Temporada de Documentos do Google para participar do programa.

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

A "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. Se a sua organização tiver suborganizações independentes, envie inscrições e propostas separadas para cada suborganização.

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

Não. Envie apenas uma inscrição por organização. Se a sua organização tiver suborganizações (por exemplo, se ela for uma fundação com muitos projetos de código aberto individuais), cada projeto precisará enviar a própria inscrição, mesmo que os fundos da bolsa sejam processados pela organização guarda-chuva.

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 todos plug-ins de um projeto maior que deseja 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 vai receber os fundos?

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

As organizações recebem algum dinheiro por participar do Google Season of Docs?

As organizações podem incluir fundos para administração, orientação ou revisão como parte dos orçamentos dos projetos.

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

Recomendamos consultar a pesquisa salarial do Write the Docs e calcular as taxas por hora. Você também pode participar do Slack do Write The Docs e pedir no canal #season-of-docs para que redatores técnicos interessados façam lances.

Minha organização pode usar a doação do Google Season of Docs para pagar um colaborador atual?

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

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

Você pode escolher estudantes para trabalhar no seu projeto. Se você escolher trabalhar com estudantes, sugerimos que limite a participação a estudantes que:

  • Ter mais de 18 anos
  • Estão matriculados em um curso ou programa de escrita técnica ou comunicação técnica
  • Ter acesso demonstrável a orientação de escrita 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 redatores técnicos que trabalham com sua organização precisam trabalhar no projeto proposto. Trabalhar com vários redatores técnicos vai aumentar a complexidade do seu projeto e exigir mais tempo de voluntariado e administração.

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

Sim, sua organização pode contratar uma empresa de redação técnica para trabalhar no projeto. Verifique se a empresa que você contrata pode receber pagamentos pelo Open Collective.

Nosso redator técnico desistiu antes do fim do programa. Ainda podemos receber o restante dos fundos?

Recomendamos que você tente encontrar um novo redator técnico para concluir seu projeto antes do fim do programa. No entanto, o desembolso dos fundos restantes não se baseia na conclusão do projeto, mas na conclusão do estudo de caso e da avaliação final.

Se não foi possível concluir seu projeto, esperamos que o estudo de caso examine o motivo. Por exemplo, talvez você tenha descoberto que a ferramenta de documentação é muito complicada e foi uma barreira para a integração de um redator técnico ou que o projeto envolveu testes e atualizações de tutoriais e exigiu muita experiência de programação. Com base na sua experiência, o que você recomendaria a outros projetos? Inclua essas informações no seu estudo de caso.

É possível analisar uma inscrição de organização antes do prazo de envio?

Não podemos dar feedback sobre a inscrição da organização.

Como as organizações devem definir o escopo das propostas de projeto?

Ao desenvolver ideias de projetos, tente encontrar os projetos menores que vão gerar valor para a organização (mas que podem ser expandidos se o tempo permitir). Quanto menor, melhor. Ao criar a proposta de projeto, recomendamos que você use projetos menores e mais detalhados em vez de projetos maiores e menos especificados. Se o projeto exigir muita experiência no domínio, tente incluir projetos que possam ser trabalhados por alguém sem esse conhecimento.

Posso participar como administrador da organização no Google Season of Docs 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 a largura de banda para participar dos dois programas, tudo bem.

Nossa organização participou de programas anteriores da Temporada de documentos do Google. Posso me inscrever novamente?

Sim, as organizações que participaram de programas anteriores da Temporada de Documentos do Google podem se inscrever novamente.

Dados arquivados

Como faço para remover minhas informações do arquivo do Google Season of Docs?

Entre em contato para remover seus dados.