Fase atual:
a temporada de 2021 do programa Documentos foi encerrada em 14 de dezembro de 2021. Consulte o
cronograma.
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 do 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 de colaborador
Problema
- Novos colaboradores não conseguem encontrar as informações de configuração necessárias para fazer contribuições significativas em nosso projeto. Alguns processos (como a contribuição com nossos testes) não estão documentados.
Como medir o sucesso?
- de aumento no número de novos colaboradores
- Aumento no número de novos colaboradores não relacionados a código (facilitando a contribuição em documentos ou testes)
- de redução no número de problemas levantados por novos colaboradores
- de aumento no número de problemas resolvidos marcados com "primeiro problema bom"
Quais habilidades um redator técnico precisaria para trabalhar neste projeto?
- Obrigatório:familiaridade com o GitHub (ou vontade de trabalhar nos tutoriais do GitHub)
- Opcional:familiaridade com nosso executor de testes para executar testes e atualizar a documentação relacionada.
Voluntários
Incentive os membros da comunidade a se inscreverem para ajudar em tarefas específicas, por exemplo:
- @JaneQDev, pode ajudar a responder perguntas sobre nossos testes
- @ChenPCoder, fico feliz em analisar as solicitações de envio de documentos
- @ErichJEngineer, pode acompanhar o processo atual de contribuição com redação técnica
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 portfolio/cursumé/CV.
Ideia de projeto: escrever tutoriais para usar nossa biblioteca com ...
Problema
- Nosso projeto traz 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?
- de redução no número de problemas marcados como "$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 relacionada a $TechnologyX
- Mais links dos projetos da $TechnologyX
Quais habilidades um redator técnico precisaria para trabalhar neste projeto?
- Opcional:algum conhecimento sobre $TechnologyX
Voluntários
Incentive os membros da comunidade a se inscreverem para ajudar em tarefas específicas, por exemplo:
- @JaneQDev, pode ajudar com perguntas sobre $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 é longa 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, nem mesmo para palavras-chave relevantes.
Como medir o sucesso?
- SEO aprimorado para nossa documentação
- de redução no número de problemas relacionados aos 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?
- Opcional: experiência em reorganizar conjuntos de documentação grandes e antigos, compreensão de SEO
Voluntários
Incentive os membros da comunidade a se inscreverem para ajudar 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: executar 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 real.
Como medir 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?
- Opcional: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 ajudar em tarefas específicas, por exemplo:
- @ChenPCoder pode ajudar a organizar o vídeo e o chat da correção e 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/abrir 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: fazer 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 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
Quais habilidades um redator técnico precisaria para trabalhar neste projeto?
- Opcional: experiência em auditoria de documentos
Voluntários
Incentive os membros da comunidade a se inscreverem para ajudar em tarefas específicas, por exemplo:
- @JaneQCoder, pode ajudar a coordenar a apresentação do roteiro de documentação na 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 em 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 de promoção e imprensa inclui logotipos e outros conteúdos que você pode usar para falar sobre a temporada de documentos.
- 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 fala sobre a documentação de Daniele Procida.