Criar uma declaração de interesse

Fase atual:
Resultados anunciados da linha do tempo.

No programa Season of Docs, as organizações trabalham diretamente com os redatores técnicos para criar, melhorar e atualizar documentação. As organizações selecionam os redatores técnicos diretamente. Os redatores técnicos interessados em trabalhar com as organizações devem apresentar uma declaração de interesse usando o canal especificado na página de propostas da organização.

Sua declaração de interesse deve incluir suas informações de contato, informações sobre sua experiência técnica de escrita e um esboço do trabalho que você faria com a organização. Também deve destacar como você atende a quaisquer requisitos específicos que a organização tenha com relação aos redatores técnicos. Leia atentamente a página de ideias do projeto da organização para ter certeza de que incluiu todas as informações necessárias.

Este modelo é um esboço para ajudá-lo a criar sua própria declaração de interesse.

Informações pessoais

  • Inclua seu nome e endereço de e-mail. Caso não queira que seu nome seja incluído nos relatórios finais de estudo de caso, indique isso em sua proposta e forneça um nome de usuário.

Informações profissionais

  • Um link para um portfólio acessível publicamente de amostras de textos ou links individuais para exemplos do seu trabalho.
  • Uma visão geral da sua experiência recente na escrita técnica: liste suas funções ou experiência profissional mais recente na escrita técnica. Se você tiver experiência com documentação de código aberto, inclua-a aqui também. Resuma sua função, as responsabilidades dela e o trabalho que você concluiu. Inclua as datas relevantes.
  • Um link para seu currículo.
  • Se a organização definiu certos requisitos para o projeto, inclua uma ou duas frases descrevendo como você atende a esses requisitos, por exemplo: “Participei de mais de seis correções de documentos como redator técnico e liderei três correções para minha equipe na XYZ Industries em 2018, 2019 e 2020”.
  • (Opcional) Outras informações que você quiser adicionar Por exemplo, seu interesse em documentação técnica, por que você quer participar da temporada de documentos ou outra experiência relevante.

Declaração do projeto

  • Título do projeto. Se a página do projeto da organização lista vários projetos possíveis, verifique se o título da declaração de interesse reflete o projeto em que você quer trabalhar. Se você estiver enviando uma declaração de interesse para uma organização que ainda não determinou possíveis projetos, seu título deve resumir o trabalho que você está propondo. Por exemplo, "Criar documentação interativa da API ProjectX" é um título melhor do que "Documentação para ProjectX".
  • Descrição detalhada.
    • Descreva como você abordaria o projeto que a organização indicou na página de proposta do projeto.
    • Diga como o que você está propondo resolverá o problema ou alcançará a meta que a organização definiu na página de proposta do projeto.
    • Inclua um resumo de todas as discussões que você teve com os membros da organização sobre o projeto.
    • Preste atenção na linguagem e no estilo da sua proposta. A organização de código aberto pode usá-las como um fator na avaliação da proposta.
  • Cronograma proposto
    • Dê um esboço geral do cronograma e das fases do projeto. Por exemplo, você pode reservar duas semanas para a coleta de informações, quatro semanas para a escrita, duas semanas para a revisão e alterações e uma semana para a publicação.
    • Incluir expectativas explícitas de participação e feedback dos integrantes do projeto. Por exemplo, você pode declarar que o cronograma depende do recebimento de respostas às consultas em até três dias.
  • Orçamento proposto
    • Recomendamos que os redatores técnicos proponham um orçamento para todo o projeto, em vez de uma taxa por hora.
    • Se possível, ofereça opções de escopo reduzido ou maior. Por exemplo, você pode dar diferentes opções de orçamento para documentar instruções de implantação para duas, quatro ou seis plataformas.