Ideias de projetos

Fase atual:
a temporada de documentos de 2019 foi concluída em 6 de março de 2020. Consulte a linha do tempo.

As ideias do projeto são sugestões de uma organização de código aberto para projetos que um redator técnico pode concluir em colaboração com um mentor durante a temporada de Documentos.

As informações nesta página são para administradores e mentores de organizações de código aberto que estão preparando suas listas de ideias de projetos. As informações também são úteis para redatores técnicos e servem como base para a participação das organizações na temporada de documentos.

Exemplos de projetos

Abaixo estão algumas ideias do tipo de projeto que um redator técnico pode abordar:

  • 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.

As ideias acima variam intencionalmente em escopo e tamanho. O tempo que um projeto leva depende de vários fatores, incluindo o tamanho do conjunto de documentação, a complexidade do produto, a experiência do redator técnico e os mentores de código aberto, as ferramentas e os processos oferecidos pelo projeto de código aberto e muito mais.

O objetivo da lista acima é ajudar você a começar. Também é possível propor outros tipos de projetos.

Publique sua lista de ideias de projeto

Publique suas ideias de projeto em uma página da Web pública, em uma postagem de blog ou em algum outro documento publicamente visível.

A página de ideias do projeto deve incluir:

  • Informações sobre sua organização de código aberto:

    • Nome da organização.
    • Descrição da organização.
    • Um link para seu repositório de código aberto e/ou site.
    • (Opcional) Um endereço de e-mail para entrar em contato com sua organização sobre a temporada dos Documentos Google. Precisa ser o mesmo endereço de e-mail incluído no formulário de inscrição da sua organização para a temporada de documentos.
    • (Opcional) Informações sobre a administração e os mentores da sua organização, como os nomes de exibição. Eles precisam ser iguais aos nomes de exibição incluídos no formulário de inscrição da sua organização para a temporada de documentos.

  • Um anúncio de que sua organização está se inscrevendo para participar da temporada dos Documentos Google deste ano. A página de promoção e imprensa inclui logotipos e outros conteúdos que você pode usar ao falar sobre a temporada de Documentos.

  • Suas ideias de projeto, incluindo as informações descritas abaixo para cada ideia.

Ao criar o aplicativo da sua organização para a temporada de documentos, inclua um link para a página de ideias de projetos.

Informações em cada ideia de projeto

Cada ideia de projeto deve incluir pelo menos as seguintes informações:

  • Nome do projeto:escolha um título conciso, mas descritivo.
  • Descrição:uma descrição mais longa do trabalho de documentação necessário. Descreva sua ideia inicial em detalhes. Ofereça oportunidades para qualquer redator técnico interessado expandir ou refinar a ideia.

  • Material relacionado:

    • Link para o projeto de código aberto que precisa de documentação.
    • Se você estiver propondo um projeto de escrita técnica que envolva atualizações de um conjunto de documentação existente, vincule a esse conjunto.
    • Se você estiver propondo um tutorial ou um conjunto de guias de instruções, descreva os recursos ou casos de uso que precisam ser documentados.
    • Se você estiver propondo o guia de um colaborador, inclua um link para qualquer arquivo README ou outro material relevante, se houver. Se não houver nada disponível ainda, não há problema em dizer isso.
    • Inclua links para documentação semelhante em outros projetos, se relevante.

A importância das ideias do projeto

As ideias do seu projeto são importantes de várias maneiras:

  • O trabalho nas ideias ajuda sua organização a formular as tarefas de documentação necessárias e a se preparar para trabalhar com um redator técnico.
  • As ideias do projeto dão aos administradores do programa do Google uma indicação do tipo de trabalho que um redator técnico abordará quando entrar em um relacionamento de mentoria com sua organização. Os administradores do programa do Google usam as ideias do projeto para julgar o compromisso da organização com a participação na temporada de documentos e orientar um redator técnico durante o programa.
  • As ideias do projeto atraem escritores técnicos interessados para sua organização. Eles podem usar os projetos sugeridos como base para as próprias propostas de projetos.