Ideias de projetos

Fase atual:
Resultados anunciados da linha do tempo.

Esta página é destinada a organizações de código aberto na fase de análise detalhada do processo de inscriçã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 projetos da organização. As organizações podem propor projetos não incluídos nesta lista.

Ideia de projeto: criar um guia de integração de colaborador

Problema

  • Os novos colaboradores não conseguem encontrar as informações de configuração necessárias para fazer contribuições significativas para nosso projeto. Alguns processos (como a contribuição com os testes) não são documentados.

Como mediríamos o sucesso?

  • de aumento no número de novos colaboradores
  • Aumento no número de novos colaboradores que não são de código (facilitando a contribuição em documentos ou testes)
  • de redução no número de problemas relatados por novos colaboradores
  • Aumento no número de problemas resolvidos marcados com "primeiro problema bom"

Quais habilidades um redator técnico precisaria para trabalhar neste projeto?

  • Necessário:familiaridade com o GitHub (ou vontade de trabalhar com tutoriais do GitHub)
  • É recomendado:conhecer nosso executor de testes para executar testes e atualizar a documentação.

Voluntários

Incentive os membros da comunidade a se inscreverem para receber ajuda em tarefas específicas, por exemplo:

  • @JaneQDev, pode ajudar a responder a perguntas sobre os testes
  • @ChenPCoder, fico 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 no projeto precisam enviar um e-mail para email@project. Inclua links para seu trabalho de redação técnica ou portfólio/currículo/CV.

Ideia de projeto: escrever tutoriais para usar a biblioteca com ...

Problema

  • Nosso projeto tem muitos problemas levantados por usuários que tentam usar nossa biblioteca com $TechnologyX. Não temos um guia claro para integração com a $TechnologyX e isso pode ser complicado.

Como mediríamos o sucesso?

  • de redução no número de problemas marcados com "$TechnologyX"
  • Aumento no número de solicitações de envio de novos colaboradores para nos ajudar a corrigir bugs ou adicionar informações à documentação de $TechnologyX
  • Mais links para nosso projeto da $TechnologyX

Quais habilidades um redator técnico precisaria para trabalhar neste projeto?

  • É recomendável:ter alguma familiaridade com a $TechnologyX

Voluntários

Incentive os membros da comunidade a se inscreverem para receber ajuda em tarefas específicas, por exemplo:

  • @JaneQDev, pode ajudar com perguntas sobre a $TechnologyX
  • @ChenPCoder, fico feliz em analisar as solicitações de envio de documentos

Dados de contato

  • Os redatores técnicos interessados em trabalhar no projeto precisam enviar um e-mail para email@project. Inclua links para seu trabalho de redação 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 simplesmente levantam problemas ou fazem perguntas em nossos fóruns. Nossas páginas não aparecem nos resultados de pesquisa, mesmo para palavras-chave relevantes.

Como mediríamos o sucesso?

  • SEO aprimorado para nossa documentação
  • Redução no número de questões levantadas para os tópicos abordados na documentação
  • Aumento no número de contribuições para documentação

Quais habilidades um redator técnico precisaria para trabalhar neste projeto?

  • É bom ter: experiência em reorganização de conjuntos de documentação grandes e antigos, compreensão de SEO

Voluntários

Incentive os membros da comunidade a se inscreverem para receber ajuda em tarefas específicas, por exemplo:

  • @ChenPCoder, fico feliz em analisar as solicitações de envio de documentos

Dados de contato

  • Os redatores técnicos interessados em trabalhar no projeto precisam enviar um e-mail para email@project. Inclua links para seu trabalho de redação técnica ou portfólio/currículo/CV.

Ideia de projeto: execute uma correção de documentação

Problema

  • Temos muitos bugs e problemas antigos relacionados à nossa documentação. Nossa comunidade ficaria feliz em contribuir e ajudar a limpar as coisas, mas precisamos de alguém para organizar e executar a correção.

Como mediríamos o sucesso?

  • Número de problemas relacionados à documentação encerrados
  • Aumento no número de contribuições para documentação e novos colaboradores

Quais habilidades um redator técnico precisaria para trabalhar neste projeto?

  • Importante:experiência na execução de uma correção de documentação
  • Ótimas habilidades organizacionais

Voluntários

Incentive os membros da comunidade a se inscreverem para receber ajuda em tarefas específicas, por exemplo:

  • @ChenPCoder, pode ajudar a organizar o vídeo e o bate-papo para a correção e a encontrar voluntários em outros fusos horários

Dados de contato

  • Os redatores técnicos interessados em trabalhar neste projeto devem enviar um e-mail para email@project/open um problema/perguntar em nosso fórum. Inclua links para seu trabalho de redação técnica ou portfólio/currículo/CV.

Ideia do projeto: faça uma auditoria da 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 roteiro ou uma noção de quais são os problemas mais urgentes. Também temos muito conteúdo desatualizado que precisa ser excluído ou arquivado.

Como mediríamos o sucesso?

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

Quais habilidades um redator técnico precisaria para trabalhar neste projeto?

  • É recomendável ter:experiência em auditoria de documentos.

Voluntários

Incentive os membros da comunidade a se inscreverem para receber ajuda em tarefas específicas, por exemplo:

  • @JaneQCoder, pode ajudar a coordenar a apresentação do roteiro 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/open um problema/perguntar em nosso fórum. Inclua links para seu trabalho de redação técnica ou portfólio/currículo/CV.