Perguntas frequentes

Fase atual:
a temporada de documentos de 2019 foi concluída em 6 de março de 2020. Consulte a 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.

A temporada de documentos é considerada um estágio, um emprego ou qualquer forma de emprego?

Não. A temporada de documentos é uma atividade que o redator técnico realiza como um redator técnico independente para a qual recebe um salário. Os redatores técnicos podem optar por recusar o recebimento do salário.

Por que devo participar da temporada de documentos?

O objetivo da Season of Docs é promover a colaboração entre organizações de código aberto e redatores técnicos. Acreditamos que esse programa vai:

  • Dê aos escritores técnicos a oportunidade de ganhar experiência na contribuição para projetos de código aberto e aprender sobre o código aberto.
  • Dê aos projetos de código aberto a oportunidade de envolver a comunidade técnica de escrita e, portanto, melhorar os documentos de código aberto.
  • Aumentar a conscientização sobre documentos de código aberto e sobre redação técnica.

Benefícios para organizações de código aberto:

  • Experiência em trabalhar com um redator técnico.
  • Documentos aprimorados.
  • O potencial de colaboração contínua com escritores técnicos após o fim da temporada de Documentos.
  • Processos aprimorados para documentar seus projetos.
  • Maior conscientização sobre documentos de código aberto entre a comunidade de escrita técnica.

Benefícios para redatores técnicos:

  • Experiência em contribuir para um projeto de código aberto.
  • Experiência com códigos e documentos voltados para desenvolvedores.
  • Crédito e reconhecimento pelo trabalho realizado.
  • Algo para adicionar ao seu currículo.
  • O potencial de colaboração contínua com o projeto de código aberto após a temporada de Documentos terminou
  • maior conscientização em comunidades de código aberto sobre o valor que os escritores técnicos podem agregar.

Que tipos de projetos os redatores técnicos podem abordar?

Confira algumas ideias:

  • Criar um site de documentação em uma plataforma a ser decidido pelo redator técnico e pelo mentor 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. Cabe à organização de código aberto publicar as ideias do projeto e escolher uma proposta de projeto enviada por um redator técnico. Se o vídeo atender aos requisitos da organização de código aberto, é possível enviá-lo como um projeto da temporada de documentos, desde que seja um vídeo de instrução técnica. Verifique 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.

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

Não. Esperamos que toda a documentação e todos os códigos disponibilizados pelo programa sejam um bom lar, mas não exigimos que as organizações usem documentos ou códigos dos redatores técnicos.

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.

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.

Posso participar da temporada de Documentos como mentor e redator técnico?

Não. Queremos garantir que cada projeto e redator técnico receba atenção suficiente e sentimos que isso pode criar uma experiência ruim para os envolvidos. Escolha se a participação como mentor ou redator técnico é mais interessante para você e planeje se inscrever.

Vou ganhar uma camiseta da temporada de Documentos?

Sim. Os participantes dos projetos concluídos com sucesso vão receber uma camiseta da temporada de documentos. A camiseta deste ano será o programa inaugural.

Quando minha camiseta chegará?

Por conta da situação da COVID-19, no momento não temos uma estimativa de quando você receberá sua camiseta. O Google contratou um fornecedor para produzir as camisetas e lidar com a logística do envio para o mundo todo. Os administradores do programa do Google vão enviar um e-mail com um código de acesso exclusivo para você selecionar o estilo/tamanho da camiseta e inserir os detalhes de frete assim que a produção for possível. A produção e o envio das camisetas geralmente leva algumas semanas.

E se eu tiver mais perguntas?

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

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 no Slack ou na lista de discussão. Veja as informações sobre canais de discussão e como entrar em contato.

Para redatores técnicos

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

A fase de inscrição para gravação técnica vai de 29 de maio de 2019 a 28 de junho de 2019. Consulte o cronograma do programa e o guia técnico do redator.

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 para 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 da temporada de Documentos?

Dependendo da natureza do seu projeto de documentação, talvez você precise 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.

Posso enviar mais de uma proposta de projeto?

Sim, mas apenas uma proposta de projeto por redator técnico será aceita. Consulte o guia sobre como criar o aplicativo.

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 você deve anotar sua relação anterior com o projeto na proposta.

Um grupo pode enviar uma proposta em conjunto para trabalhar em um único projeto?

Não, somente um indivíduo pode trabalhar em um determinado projeto.

Posso entrar em contato diretamente com as organizações de mentoria antes de enviar uma proposta para a temporada de documentos?

Sim, você pode se comunicar diretamente com a organização de código aberto com que tem interesse em trabalhar antes de enviar sua inscrição para a temporada de documentos. Os mentores de código aberto podem ajudar você a refinar a ideia do projeto.

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

Vocês abrirão uma exceção aos requisitos de qualificação para mim?

Não. Não podemos abrir exceções se você não atender aos requisitos de qualificação, não importa seu talento ou interesse. Fazer uma exceção para você não seria justo com os outros redatores técnicos que se candidatassem para participar da temporada de Documentos.

Que formulários preciso fornecer?

Os participantes aceitos precisarão fornecer as declarações fiscais apropriadas.

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 proposta de projeto, é possível 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. O programa Season of Docs tem como objetivo trabalhar com redatores técnicos experientes ou em treinamento com mentores de código aberto, para que cada um possa aprender uns com os outros. 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á um salário aos redatores técnicos que concluírem o programa com sucesso. Você pode optar por desativar o recebimento do salário. Veja os detalhes da financiamento técnico.

Vou receber o pagamento mesmo se a organização não usar minha documentação ou código?

Sim, desde que o projeto seja aprovado na avaliação final do mentor de código aberto. Se o projeto de código aberto usar ou não a documentação ou o código produzido, isso não afeta o pagamento da receita do redator técnico.

Como é uma boa proposta de redator técnico?

As melhores propostas são de redatores técnicos que dedicam um tempo para interagir e discutir ideias com a organização de código aberto escolhida antes de enviar as inscrições para a temporada de documentos. Consulte o guia sobre como criar seu aplicativo.

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

O tempo gasto depende da natureza do projeto acordado com a organização do mentor. O requisito de número de horas é deliberadamente flexível, para permitir diferentes tipos de projeto e estilos de trabalho.

Antes de enviar sua proposta de projeto, avalie o projeto e discuta uma estimativa de tempo com a organização de código aberto. Se for difícil para você gastar a quantidade estipulada de tempo devido a outros compromissos, há uma opção para concluir o projeto em um período mais longo e ainda receber o orçamento e o reconhecimento do trabalho realizado. Ao enviar seu aplicativo da temporada de documentos, especifique a opção para um projeto de longa duração.

Estou estudando comunicação técnica, mas ainda não tenho experiência profissional. Posso participar mesmo assim?

Sim. Ao enviar a proposta de projeto, liste seus cursos universitários ou universitários na seção de experiência profissional prévia.

Sou estudante aceito nos Estados Unidos com um visto F1. Como faço para receber autorização para participar?

Converse com o departamento internacional de assuntos estudantis da sua escola para mais detalhes. O Google não pode fornecer a você nenhum tipo de autorização CPT ou OT.

Todos os participantes aceitos vão receber um e-mail de confirmação. Não oferecemos letras personalizadas.

Como a temporada de documentos usa as informações de meu formulário de inscrição?

Os administradores do programa do Google transmitem algumas das informações do seu aplicativo aos administradores da organização de código aberto escolhida, para que a organização possa avaliar a proposta de projeto.

Se o projeto for aceito no programa, a temporada de documentos publicará os detalhes do projeto no site.

Veja a descrição do uso de dados no guia do formulário de inscrição de gravador técnico.

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

Quero saber mais sobre como participar como mentor na temporada de Documentos. Onde encontro mais informações?

Leia o guia do mentor e as regras do programa para saber mais sobre como se tornar um mentor da temporada de Documentos Google.

Quais são os requisitos de qualificação para uma organização mentora?

Para se qualificar para participar como uma organização de mentoria, você precisa ser um grupo que executa um projeto de software ativo/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 de mentoria já precisam ter produzido e lançado um software com uma licença aprovada da Iniciativa de código aberto e pelo menos dois colaboradores para atuar como administradores e/ou mentores 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.

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

As organizações em situação regular receberão um salário por redator técnico aceito no final do programa. Isso independe do projeto do redator técnico ser bem-sucedido ou não. As organizações podem usar esses fundos como quiserem.

Como os administradores do programa do Google alocam slots para projetos de redação técnica?

O piloto da temporada de documentos de 2019 está limitado a um máximo de 50 projetos de redação técnica no total.

Como diretriz, esperamos aceitar no máximo dois projetos por organização, para não acabar com muitos projetos aceitos. No entanto, se o processo de seleção sem custo financeiro não preencher todos os slots, os administradores do programa do Google poderão alocar slots adicionais para algumas organizações.

Portanto, ao enviar sua seleção de projetos de escrita técnica, é possível selecionar mais de dois projetos. Certifique-se de listar suas seleções em ordem de prioridade, com sua prioridade máxima no topo da lista.

Em suas comunicações com os redatores técnicos, deixe claro que o projeto não será aceito até que os administradores do programa do Google publiquem a lista de projetos aceitos no site do programa.

Posso participar da temporada de Documentos ao mesmo tempo como administrador e mentor da organização?

Sim. Um administrador da organização também pode ser um mentor. Você não precisa preencher um formulário de mentor separado. Ao preencher o formulário de inscrição para organizações ou o formulário de administrador alternativo, use a opção desse formulário para indicar que você também está atuando como mentor.

Posso participar como administrador da organização ou mentor na temporada de Documentos Google e 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.

Posso participar como administrador da organização ou mentor na temporada de Documentos Google e no Google Code-in?

Sim. A temporada de documentos e o Google Code-in são programas separados. Se você tiver largura de banda para participar dos dois programas, tudo bem.

Dados arquivados

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

Entre em contato para remover suas informações.