Perguntas frequentes

Fase atual:
Resultados anunciados da linha do tempo.

Geral

A temporada de documentos é um programa de recrutamento?

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

Qual é a diferença entre o programa atual e a temporada de documentos de 2019 e 2020?

O programa atual da temporada de documentos tem mudanças significativas em relação aos anos anteriores, incluindo:

  • Os redatores técnicos não se inscrevem mais por meio do Google para ser comparados com organizações
  • As organizações enviam propostas de projetos como parte da inscrição, incluindo um orçamento e as métricas propostas
  • As organizações aceitas recebem subsídios, que eles usam para pagar os redatores técnicos
  • As organizações enviam avaliações finais e estudos de caso

Por que a temporada de documentos fez essas mudanças?

No Google, nossa missão é organizar as informações mundiais e torná-las universalmente acessíveis e úteis. Ao mudar o foco da temporada de documentos para enfatizar o aprendizado sobre práticas de documentação eficazes em código aberto, esperamos causar um impacto maior a longo prazo.

Nossa organização quer participar da temporada de documentos, 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 técnica de redação (experimente o canal #season-of-docs no Escreva o Slack do Documentos 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. Exemplos de plataformas:

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

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

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

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

Sim. Confira se os requisitos de vídeo estão bem definidos e lembre-se de que a produção de um vídeo de alta qualidade demanda tempo e recursos significativos.

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

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

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

A temporada de documentos tem um repositório do GitHub (em inglês) com um modelo e uma lista de verificação para realizar auditorias de documentação. Esperamos adicionar outros modelos à medida que eles forem criados.

O The Good Docs Project está trabalhando para criar alguns modelos de documentação mínimos viáveis 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 do motivo pelo qual 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?

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

Como posso ficar por dentro da temporada de documentos?

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

Posso adicionar a linha do tempo da temporada de documentos à minha agenda?

Sim, ele pode ser adicionado usando este link.

Como posso ajudar a divulgar a temporada de Documentos?

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

Como faço para organizar ou organizar uma sessão informativa ou encontro de informações sobre a temporada de documentos?

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

Há alguma estatística que você possa compartilhar sobre as temporadas de 2019 e 2020 do Documentos?

Sim, é possível conferir os resultados da temporada de documentos do programa de 2019 aqui e os resultados do programa de 2020 podem ser acessados aqui.

Vou ganhar uma camiseta da temporada de Documentos?

Não. Devido a restrições de frete internacional, não poderemos mais fornecer camisetas aos participantes que concluírem o projeto da temporada de documentos.

E se eu tiver mais perguntas?

Dê uma olhada no guia para administradores da organização e no guia de redação técnica.

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

Como faço para ser mentor na temporada de Documentos?

A temporada de Documentos não tem um papel formal de mentor. As organizações precisam especificar como os redatores técnicos serão integrados e apoiados e como as contribuições de documentação deles serão revisadas e aprovadas como parte da inscrição da organização. Se você tiver interesse em orientar redatores técnicos como parte da temporada de documentos, incentivamos você a trabalhar com os administradores da organização para se voluntariar.

A temporada de documentos é parecida com o Google Summer of Code?

Não. A temporada de documentos é destinada a pessoas com alguma experiência técnica de escrita. Ela não foi criada 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?

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

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

As ferramentas e frameworks de documentação que você usará dependem da organização com que você tem interesse em trabalhar. Parte do objetivo da Season of Docs é que os projetos de código aberto ajudem os escritores 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 da temporada de documentos.

Dito isso, a maioria das organizações de código aberto usa algum tipo de Markdown ou outra linguagem de marcação para sua documentação. Recomendamos que você descubra qual linguagem seja usada pela organização escolhida e se familiarize com a sintaxe. O 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, se houver, em 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 documentos nas páginas "Leia os documentos" ou do GitHub. Depois de descobrir qual plataforma a organização usa, explore e teste a linguagem e o framework relevantes. Isso ajuda a dar os primeiros passos rapidamente com o projeto de código aberto e coloca você em um bom lugar para dar conselhos sobre o projeto de código aberto de sua escolha.

Quais linguagens de programação eu preciso saber para participar dos projetos da temporada de documentos?

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á estão trabalhando em um projeto de código aberto podem continuar trabalhando nele como parte da temporada de documentos?

Sim, mas a organização precisa anotar na proposta o relacionamento anterior ou contínuo do redator técnico com o projeto.

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

Preciso ter experiência ou treinamento para redator técnico?

De preferência, mas não essencial, é preferível ter experiência prévia em escrita técnica ou treinamento. Ao enviar uma declaração de interesse para uma organização, você pode descrever sua experiência e/ou treinamento em escrita técnica. Forneça evidências que demonstrem interesse na 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 necessário para garantir a conclusão bem-sucedida dos projetos da temporada de documentos.

Vou receber por participar da temporada de documentos?

Sim. O Google fornecerá subsídios às organizações aceitas para usar elaboradores técnicos.

Como é a declaração de interesse de um bom redator técnico?

As melhores declarações de interesse são de escritores técnicos que dedicam um 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 para criar sua declaração de interesse.

Quanto tempo leva a participação na temporada de Documentos?

Os tamanhos do projeto 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 se comprometer, 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 contribuidor do projeto.

Não, você só deve enviar a proposta se puder receber fundos em nome do projeto de código aberto. Encorajamos você a entrar em contato com o projeto e colaborar em uma proposta de inscrição.

Sou estudante, posso participar da temporada de Documentos Google? A temporada de documentos me ensinará a ser um escritor técnico?

Os alunos estão qualificados para trabalhar em organizações aceitas, mas a temporada de documentos não tem o objetivo de ensinar habilidades de escrita técnica. Esperamos que os redatores técnicos participantes tenham habilidades profissionais de escrita técnica ou experiência relevante equivalente. Os estudantes que quiserem participar precisam destacar a experiência relevante de escrita e edição ao entrar em contato com organizações e projetos interessados.

Posso participar como redator técnico na Temporada de Documentos e estudante no Google Summer of Code?

Embora isso não seja contra as regras atualmente, sugerimos que os estudantes aceitos no Google Summer of Code não se inscrevam para ser um redator técnico da Temporada de Documentos. Os alunos precisam se concentrar no trabalho do Google Summer of Code em vez de se inscrever na temporada de documentos.

Além disso, a temporada de documentos não é destinada a iniciantes, ela é destinada a pessoas que já têm sólidas habilidades e experiências técnicas de redação. Os redatores técnicos não são mentores 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 da temporada de documentos do Google se eu tiver outras dúvidas ou preocupações?

Você pode entrar em contato com os administradores do programa do Google na temporada de documentos do Google. Para isso, envie um e-mail para 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 mencionar a temporada de documentos no meu currículo?

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

Você fornece certificados de conclusão para participar da temporada de documentos?

Não podemos enviar certificados ou confirmações de participação no projeto aos redatores técnicos.

Para administradores da organização de código aberto

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

Para se qualificar para participar como organização, você precisa fazer parte de um grupo que executa um projeto de software ativo/sem custo financeiro, 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 softwares sob 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.

Consulte também os requisitos de qualificação descritos nas regras do programa e os Programas de sanções e Informações sobre países 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 solicitação de proposta?

Não. Envie apenas uma inscrição por organização. Caso sua organização tenha suborganizações (por exemplo, seja uma fundação com muitos projetos de código aberto individuais), cada projeto precisa enviar a própria inscrição, mesmo que os fundos da concessão 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 de um projeto maior e que querem trabalhar em um guia de instruções conjunto para a criação de plug-ins deve 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 Open Collective.

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

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 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 cobre a taxa da plataforma Open Collective, e se você decidir usar o Open Collective como seu host fiscal, a taxa também será coberta. Consulte o guia para receber concessões para mais informações.

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

Recomendamos consultar a Pesquisa salarial do Documentos e calcular as taxas por hora. Participe também do Write The Docs Slack (em inglês) e peça para os redatores técnicos interessados darem um lance no canal #season-of-docs.

Minha organização pode usar a concessão da temporada de documentos 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). Você não pode solicitar uma concessão a ser usada para pagar pelo trabalho já concluído.

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

Você pode solicitar que os redatores técnicos de alunos trabalhem em seu projeto. Se você optar por trabalhar com estudantes, sugerimos que limite a participação aos 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 demonstrável à mentoria de redação técnica por meio do 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 que trabalham com sua organização precisam trabalhar no projeto que você propôs. Trabalhar com vários redatores técnicos aumenta a complexidade do projeto e exige mais tempo de voluntariado e administração.

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

Sim, sua empresa pode contratar uma empresa de redação técnica para trabalhar em seu projeto. Verifique se a empresa que você contrata pode ser paga pelo Open Collective.

Nosso redator técnico saiu antes do fim do programa. Ainda estamos qualificados para receber os fundos restantes?

Recomendamos que você tente encontrar um novo redator técnico para concluir seu projeto antes do final 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 o projeto não foi concluído, esperamos que seu estudo de caso examine o motivo. Por exemplo, talvez você descobriu que as ferramentas de documentação são muito complicadas e se mostrou uma barreira para a integração de um redator técnico, ou que seu projeto envolveu testes e atualizações de tutoriais e exigiu muita 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?

Não podemos fornecer feedback sobre a inscrição 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, que são menos especificados. Se o projeto exigir muita experiência no domínio, tente incluir projetos que poderiam ser trabalhados por alguém sem esse conhecimento.

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

Sim. A 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 de programas anteriores da temporada de documentos. Podemos nos inscrever novamente?

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?

Entre em contato para remover suas informações.