Fase atual:
resultados anunciados. Consulte a
linha do tempo.
Esta página destina-se a organizações de código aberto na fase de exploração do processo de solicitação da organização. Essas ideias de projeto são apenas exemplos para mostrar como as organizações podem descrever possíveis projetos de documentação na página de ideias de projeto da organização. As organizações podem propor projetos não incluídos nesta lista.
Ideia de projeto: criar um guia de integração para colaboradores
Problema
- Os novos colaboradores não conseguem encontrar as informações de configuração necessárias para fazer contribuições significativas ao nosso projeto. Alguns processos, como a contribuição para nossos testes, não são documentados.
Como mediríamos o sucesso?
- Aumento no número de novos colaboradores
- Aumento no número de novos colaboradores sem código (facilitando a contribuição de documentos ou testes)
- Diminuição no número de problemas levantados por novos colaboradores
- Aumento no número de problemas encerrados com a tag "bom primeiro problema"
Quais habilidades um redator técnico precisa ter para trabalhar nesse projeto?
- Requisito:familiaridade com o GitHub (ou disposição para trabalhar com tutoriais do GitHub)
- Legal ter:familiaridade com nosso executor de testes para executar nossos testes e atualizar a documentação para isso.
Voluntários
Incentive os membros da comunidade a se inscreverem para ajudar com tarefas específicas. Por exemplo:
- @JaneQDev, pode ajudar a responder a perguntas sobre nossos testes
- @ChenPCoder, feliz em analisar as solicitações de envio de documentos
- @ErichJEngineer, pode explicar o processo de contribuição atual com o redator técnico?
Dados de contato
- Os redatores técnicos interessados em trabalhar neste projeto devem enviar um e-mail para email@project. Inclua links para seu trabalho de escrita técnica ou portfólio/currículo/CV.
Ideia de projeto: escrever tutoriais para usar nossa biblioteca com ...
Problema
- Nosso projeto recebe muitos problemas levantados por usuários que tentam usar nossa biblioteca com $TechnologyX. Não temos um guia claro para a integração com a $TechnologyX, e isso pode ser complicado.
Como medir o sucesso?
- Diminuição no número de problemas com a tag "$TechnologyX"
- Aumento no número de solicitações de pull de novos colaboradores que nos ajudam a corrigir bugs ou adicionar à documentação sobre $TechnologyX
- Mais links para nosso projeto de projetos da $TechnologyX
Quais habilidades um redator técnico precisa ter para trabalhar nesse projeto?
- Opcional:alguma familiaridade com $TechnologyX
Voluntários
Incentive os membros da comunidade a se inscrever para ajudar com tarefas específicas, por exemplo:
- @JaneQDev pode ajudar com respostas sobre a $TechnologyX
- @ChenPCoder, feliz em analisar as solicitações de envio de documentos
Dados de contato
- Os redatores técnicos interessados em trabalhar neste projeto devem enviar um e-mail para email@project. Inclua links para seus trabalhos de escrita técnica ou portfólio/currículo/CV.
Ideia do projeto: reorganizar nossa documentação
Problema
- Nossa documentação é extensa e desorganizada. Muitos usuários desistem de tentar encontrar respostas na documentação e apenas levantam problemas ou fazem perguntas em nossos fóruns. Nossas páginas não aparecem nos resultados da pesquisa, mesmo para palavras-chave relevantes.
Como mediríamos o sucesso?
- Melhor SEO para nossa documentação
- Diminuição do número de problemas levantados para os tópicos abordados na documentação
- Aumento no número de contribuições de documentação
Quais habilidades um redator técnico precisa ter para trabalhar nesse projeto?
- Desejável:experiência na reorganização de conjuntos de documentação grandes e maduros, conhecimento de SEO
Voluntários
Incentive os membros da comunidade a se inscrever para ajudar com tarefas específicas, por exemplo:
- @ChenPCoder, feliz em analisar as solicitações de envio de documentos
Dados de contato
- Os redatores técnicos interessados em trabalhar neste projeto devem enviar um e-mail para email@project. Inclua links para seu trabalho de escrita técnica ou portfólio/currículo/currículo.
Ideia de projeto: executar uma correção de documentação
Problema
- Temos muitos pequenos bugs e problemas antigos relacionados à nossa documentação. Nossa comunidade vai ficar feliz em ajudar a limpar as coisas, mas precisamos de alguém para organizar e executar o fixit.
Como mediríamos o sucesso?
- Número de problemas fechados relacionados à documentação
- Aumento no número de contribuições de documentação e novos colaboradores
Quais habilidades um redator técnico precisa ter para trabalhar nesse projeto?
- Opcional:experiência na execução de um fixit de documentação.
- Ótimas habilidades organizacionais
Voluntários
Incentive os membros da comunidade a se inscrever para ajudar com tarefas específicas, por exemplo:
- @ChenPCoder, pode ajudar a organizar o vídeo e o chat para a correção e a encontrar voluntários
Dados de contato
- Os redatores técnicos interessados em trabalhar neste projeto devem enviar um e-mail para email@project/abrir um problema/perguntar no nosso fórum. Inclua links para seu trabalho de redação técnica ou portfólio/currículo/CV.
Ideia de projeto: fazer uma auditoria de documentação
Problema
- Não temos uma boa ideia do estado da nossa documentação. É difícil priorizar melhorias na documentação porque não temos um cronograma ou uma noção dos problemas mais urgentes. Também temos muito conteúdo desatualizado que precisa ser excluído ou arquivado.
Como mediríamos o sucesso?
- Criação de um roteiro de documentação com aprovação geral da comunidade
- Redução no número de páginas de documentação desatualizadas ou incorretas
Que habilidades um redator técnico precisa para trabalhar neste projeto?
- Opcional: experiência em auditoria de documentos
Voluntários
Incentive os membros da comunidade a se inscrever para ajudar com tarefas específicas, por exemplo:
- @JaneQCoder, pode ajudar a coordenar a apresentação do planejamento da documentação na nossa reunião da comunidade
Dados de contato
- Os redatores técnicos interessados em trabalhar neste projeto devem enviar um e-mail para email@project/abrir um problema/perguntar no nosso fórum. Inclua links para seu trabalho de redação técnica ou portfólio/currículo/CV.
Informações relacionadas
- A página promoção e imprensa inclui logotipos e outros conteúdos que você pode usar ao falar sobre a Temporada de documentos do Google.
- Este vídeo da PyCon Australia 2017 dá dicas sobre como organizar sua documentação para que as pessoas a considerem útil: O que ninguém conta sobre documentação por Daniele Procida.