A equipe de Documentação acompanha, modifica e aprimora a documentação em todo o projeto WordPress, incluindo: NúcleoNúcleo O núcleo é o conjunto de softwares necessários para executar o WordPress. A Equipe de Desenvolvimento do Núcleo desenvolve o WordPress., o Codex, os próximos Handbooks e outras partes do WordPress.orgWordPress.org O site da comunidade onde o código do WordPress é criado e compartilhado pelos usuários. É onde você pode baixar o código-fonte do núcleo, dos plugins e dos temas do WordPress, além de ser o local central para conversas e organização da comunidade. https://wordpress.org/ e de sites relacionados. Em todo o projeto, problemas de código e design são acompanhados no tracTrac O Trac é o local onde os colaboradores criam problemas para bugs ou solicitações de recursos, de forma semelhante ao GitHub.https://core.trac.wordpress.org/. (tanto nos tracs do núcleo quanto nos do metaMeta Meta é um termo que se refere ao funcionamento interno de um grupo. Para nós, essa é a equipe que trabalha em sites internos do WordPress, como o WordCamp Central e o Make WordPress.), mas esse método não é o mais eficiente para acompanhar problemas de documentação. Assim, a equipe de Documentação propôs um rastreador de problemas de documentação.
Objetivos
O rastreador de problemas de documentação tem dois objetivos principais:
- facilitar o relato de problemas em todo o projeto para a equipe de Documentação
- facilitar o acompanhamento dos problemas relatados
Um rastreador de problemas de documentação bem-sucedido acabará melhorando a documentação em todo o projeto.
Partes interessadas
A equipe de documentação é a principal parte interessada neste projeto, já que usará principalmente o rastreador.
É necessário um responsável.
@samuelsidler gerenciará o projeto e trabalhará com a equipe de documentação e o responsável.
Soluções
Há dois recursos principais em um rastreador de problemas de documentação:
- interface de relato
- interface de acompanhamento
Para garantir que cumpramos nossos objetivos, usaremos as seguintes métricas:
- testes com usuários finais relatando problemas de documentação (para garantir que seja fácil)
- feedback da equipe de Documentação sobre o acompanhamento
Componentes
Conforme declarado acima, há dois componentes no rastreador de problemas de documentação: Relato e Acompanhamento.
Relato
A interface de relato precisará coletar automaticamente (quando possível) algumas informações para envio ao rastreador. Especificamente, coletaremos o nome de usuário de quem relata, a data em que um problema foi relatado, um tipo de problema (selecionável pelo usuário), um link para a página (usando o referenciador, quando possível) e uma descrição personalizada criada pelo usuário. Os usuários precisarão estar conectados à sua conta do wordpress.org para relatar um problema. Se não estiverem conectados, nós os redirecionaremos primeiro para a página de login. Pode haver interações que sejam interrompidas nesse ponto; por exemplo, o referenciador pode ser perdido se o usuário precisar fazer login antes de relatar um problema.
Ainda precisamos determinar onde essa interface de relato existirá (somente em uma página específica ou um link em todos os lugares?)
Etapas concluídas:
- detalhes adicionais determinados sobre quais informações coletar e quando
- @karmatosed projetou a interface de relato
- primeiros mockups publicados para receber feedback
- mockup final criado
- @Otto42 concordou em desenvolver a interface de relato
Próximas etapas:
- trabalhar com as equipes de Documentação e Meta para determinar onde a interface ficará
Acompanhamento
A interface de acompanhamento será usada principalmente pela equipe de Documentação para acompanhar problemas recebidos e ativos. Parte dessa interface envolve visualizar problemas individualmente e alterar seu status. Editores (ou Jardineiros) precisarão de permissões específicas para realizar ações. Mais especificamente, exigiremos que os usuários tenham a função de usuário “Editor” para resolver problemas.
Na interface de acompanhamento, queremos exibir as seguintes informações: nome de usuário de quem relata, data em que um problema foi relatado, tipo de problema, link para a página, pessoa atribuída a um problema, um botão que atribui um problema a você e uma caixa de seleção para resolução. Existirá uma descrição criada pelo usuário, que poderá ser exibida com uma “seta de revelação”.
Etapas concluídas:
- decisões tomadas sobre as informações específicas necessárias e as funções de usuário que poderão resolver problemas
- @karmatosed projetou a interface de acompanhamento
- primeiros mockups publicados para receber feedback
- mockup final criado
- @Otto42 concordou em desenvolver a interface de acompanhamento (possivelmente usando o P2P2 P2 ou O2 é o termo usado pelas pessoas para se referir ao blog Make WordPress. Ele pode ser encontrado em https://make.wordpress.org com as publicações resolvidas do pluginPlugin Um plugin é um software que contém um grupo de funções que pode ser adicionado a um site WordPress. Ele pode ampliar funcionalidades ou adicionar novos recursos aos seus sites WordPress. Os plugins do WordPress são escritos na linguagem de programação PHP e integram-se perfeitamente ao WordPress. Eles podem ser gratuitos no Diretório de Plugins do WordPress.org https://wordpress.org/plugins/ ou podem ser plugins pagos de terceiros.)
Próximas etapas:
- determinar onde o rastreador ficará
Observação: No momento, este rastreador de problemas provavelmente terá uma interface de acompanhamento única para todos e não permitirá muita personalização quanto ao acompanhamento. No entanto, futuramente queremos permitir a classificação por “componente”.