Fase atual:
a temporada de documentos de 2019 foi concluída em 6 de março de 2020. Consulte a
linha do tempo.
Esta página contém dicas para redatores técnicos sobre como concluir as principais partes de um aplicativo para participar da temporada de documentos. Essas informações ajudam a entender quais fatores as organizações de código aberto podem considerar ao selecionar os projetos técnicos de redação que querem orientar durante a temporada de Documentos.
Introdução
As diretrizes abaixo são geralmente aplicáveis à Temporada de Documentos. Cada organização de código aberto individual pode ter critérios de avaliação específicos. Entre em contato com qualquer uma das organizações participantes antes de enviar sua inscrição para discutir os requisitos e planejar sua proposta de projeto. Consulte a fase de exploração técnica do gravador descrita no guia técnico do escritor.
Formulário de inscrição
O formulário de inscrição está disponível no guia técnico durante a fase de inscrição do gravador técnico.
Depois de enviar o formulário, é possível continuar atualizando as informações até o final da fase de inscrição do redator técnico (28 de junho de 2019).
Informações pessoais
As seguintes informações pessoais são solicitadas no formulário de inscrição:
Seu nome:informe seu nome completo. A temporada de documentos não vai compartilhar esse nome com as organizações de código aberto e não vai publicá-lo no site.
Um nome de exibição de sua escolha:forneça o nome que você quer usar como identificador público durante a participação na temporada de Documentos. É altamente recomendável não usar seu nome completo no nome de exibição. A temporada de documentos compartilhará seu nome de exibição com a organização de código aberto indicada no formulário de inscrição. A temporada de documentos publicará seu nome de exibição no site na lista de projetos técnicos de redação aceitos.
Seu endereço de e-mail:forneça o endereço de e-mail associado à sua Conta do Google. É necessário ter uma conta do Google para participar da temporada de Documentos. Você pode usar um endereço de e-mail que não seja do Gmail com uma Conta do Google. Consulte este artigo de ajuda. A temporada de documentos usa seu endereço de e-mail para se comunicar com você e disponibilizar os recursos do site. A temporada de documentos compartilhará esse endereço de e-mail com a organização de código aberto indicada no seu formulário de inscrição. A temporada de Documentos não publicará esse endereço de e-mail no site.
Confira abaixo um resumo de como a temporada de documentos usa as informações do seu formulário de inscrição.
Informações sobre sua experiência técnica de escrita
Quando os mentores de código aberto e os administradores da organização examinam uma proposta de projeto, eles estão interessados na sua experiência técnica de escrita. Você pode fornecer detalhes no formulário da seguinte maneira:
Experiência recente de escrita técnica:use até três entradas em que é possível listar seus cargos técnicos ou experiência de trabalho mais recentes. Se você tiver experiência com documentação de código aberto, inclua-a aqui também. Resuma seu papel, as responsabilidades dele e o trabalho que você realizou. Você pode fornecer datas quando for relevante.
Um link para seu currículo:(opcional) O URL de uma versão acessível publicamente do seu currículo ou curriculum vitae (CV).
Um link para suas amostras de trabalho:(opcional) É o URL de um portfólio de amostras de textos acessíveis publicamente ou links individuais para exemplos do seu trabalho.
Outros itens que você quer adicionar: (opcional) Todas as informações que você quiser adicionar ao aplicativo. Por exemplo, seu interesse em documentação técnica, por que você quer participar da temporada de documentos ou outra experiência relevante.
Proposta de projeto
Sua proposta de projeto é um resumo do trabalho de documentação que você quer concluir ao trabalhar com a organização de código aberto escolhida durante a temporada de Documentos.
é possível enviar até três propostas de projeto. Todas as propostas de projeto precisam estar no mesmo formulário.
Dedique tempo à proposta de projeto, tendo em mente as diretrizes a seguir.
Trabalho preparatório:
Examine a lista de organizações de código aberto participantes e escolha uma ou mais organizações de seu interesse. Dê uma olhada nas ideias de projeto que cada uma das organizações de código aberto escolhidas propôs.
Caso a organização em que você tem interesse não tenha sugerido nenhuma ideia, examine a lista genérica de ideias de projetos e baseie sua ideia em uma delas. Você também pode escolher apresentar sua própria ideia, independentemente de a organização ter postado ideias ou não.
Entre em contato com uma ou mais das organizações participantes para discutir as ideias do projeto. Para fazer contato, use o endereço de e-mail exibido na lista de organizações participantes. Discussões iniciais ajudam a montar uma boa proposta de projeto.
Sua proposta de projeto no formulário de inscrição:
Nome da organização de código aberto:digite o nome da organização de código aberto com a qual você quer trabalhar durante a temporada de documentos. Precisa ser uma das organizações participantes exibidas no site da temporada dos Documentos.
Nome do projeto de código aberto:é o nome do projeto de código aberto em que você quer trabalhar durante a temporada de documentos. O projeto precisa pertencer a uma das organizações participantes exibidas no site da temporada dos Documentos. Para algumas organizações, os nomes da organização e do projeto podem ser os mesmos.
O nome do projeto de escrita técnica proposto. Forneça um título curto e descritivo que resuma o objetivo principal do trabalho que você está propondo.
Uma descrição detalhada. Forneça o máximo de detalhes possível na descrição do projeto técnico de escrita que você está propondo. É bom inserir vários parágrafos no campo de descrição. Veja algumas ideias do que incluir:
- Forneça detalhes sobre a documentação que você quer criar/atualizar. Se você planeja atualizar um documento ou site existente, inclua um link e descreva as atualizações propostas. Se estiver propondo um novo documento ou um novo site, descreva o conteúdo e o público-alvo.
- Diga por que você está propondo a nova documentação ou as atualizações.
- Se você discutiu o projeto com alguém da organização de código aberto, inclua um resumo do resultado dessas discussões.
- Preste atenção na linguagem e no estilo da sua proposta. A organização de código aberto pode usar esses fatores como fator na avaliação da proposta.
- Não forneça um link para a descrição do projeto. A descrição precisa incluir todos os detalhes definitivos do projeto. A organização de código aberto precisa ser capaz de fazer uma seleção com base no conteúdo do formulário de inscrição, e não no conteúdo mantido em outro lugar. Se você precisar vincular a outro conteúdo que complemente a descrição, tudo bem, mas esteja ciente de que apenas o conteúdo do formulário de inscrição será usado para a seleção do projeto.
Outros campos importantes no formulário de inscrição
Confira abaixo as diretrizes sobre outras informações importantes que você precisa enviar no formulário de inscrição:
Escolher um projeto de duração padrão ou de longa duração: o período padrão para a fase de desenvolvimento de documentos da temporada de documentos é de três meses. Se o projeto exigir um período mais longo, indique isso no formulário de inscrição após consultar a organização de código aberto de sua escolha. Consulte a descrição de projetos de longa duração.
Recebimento da temporada de documentos:esse período paga uma quantia em dinheiro para os redatores técnicos que concluem os projetos com sucesso, desde que o redator técnico queira aceitar o salário. Veja as informações sobre benefícios para redação técnica. O salário é opcional. Se você não quiser receber o salário, indique sua escolha no formulário de inscrição.
Como a temporada de documentos usa as informações do seu formulário de inscrição
Nesta seção, resumimos como a Season of Docs usa as informações do seu formulário de inscrição. Nas seções anteriores desta página, descrevemos os campos-chave em detalhes.
A tabela lista os principais campos. Para cada campo, a tabela indica se a temporada dos documentos:
- Transmite as informações para a organização de código aberto especificada no formulário de inscrição.
- Publica as informações na lista de projetos técnicos de redação aceitos no site da temporada de documentos.
| Informações no formulário | Compartilhada com a organização de código aberto? | Exibido no site da temporada de documentos? |
|---|---|---|
| Nome completo | ||
| Nome de exibição | ||
| Endereço de e-mail | ||
| Experiência recente em escrita técnica | ||
| Link para currículo | ||
| Link para amostras de trabalho | ||
| Qualquer outra informação que você queira adicionar | ||
| Nome do projeto/organização de código aberto | ||
| Nome e descrição do projeto de escrita técnica | ||
| Projeto de longa duração ou de duração padrão | ||
| Aceitação de salário |
Chave para os símbolos usados na tabela acima:
| Símbolo | Significado do símbolo |
|---|---|
| Sim | |
| Não |
Observações
Veja mais alguns pontos que você deve ter em mente:
Enviar várias propostas de projeto:é possível enviar mais de uma, mas a temporada de documentos aceita apenas uma proposta por redator técnico. Só é possível enviar um formulário de inscrição. O formulário permite até três propostas de projeto.
Número total de projetos de escrita técnica no programa: a temporada de documentos só pode aceitar um determinado número máximo de projetos de escrita técnica no total. Veja como funciona a alocação de slots.
Guias relacionados
Dê uma olhada nas dicas para mentores sobre como avaliar as propostas de redatores técnicos. Entender os critérios de seleção dos mentores ajuda você a criar uma proposta com mais chances de ser bem-sucedida.
Para informações processuais sobre quando e como enviar sua inscrição na temporada de documentos, consulte o guia de redação técnica.