Um novo sistema de feedback está chegando ao docs.microsoft.com

Este post foi escrito por Rob Eisenberg, Gerente de Programa Sênior da equipe de docs.microsoft.com.

A missão da Microsoft é capacitar todas as pessoas e todas as organizações do planeta para alcançar mais. Esta foi uma das nossas considerações, pois construímos docs.microsoft.com sobre a plataforma aberta do GitHub. Hoje, estamos levando isso para o próximo nível com a mudança para um novo sistema de feedback de documentação baseado no GitHub.

Feedback de conteúdo no GitHub

Embora nossa documentação esteja no GitHub desde o início, nosso mecanismo de feedback de conteúdo tem usado o Livefyre para comentários em artigos. Embora o Livefyre seja uma ótima solução de comentários, acabou sendo insuficiente para nossas necessidades específicas, que é rastrear, atribuir proprietários e manter o estado dos problemas de conteúdo levantados pelos clientes.

Exploramos uma série de caminhos para torná-lo melhor, mas uma questão que guiou grande parte do nosso trabalho pareceu ressurgir: Se nossa documentação fosse tratada como código aberto, o que usaríamos para resolver esse problema? A resposta para a pergunta parecia óbvia: problemas do GitHub, então começamos a experimentar a integração das APIs do GitHub mais profundamente em nossas páginas de documentação, sendo capazes de construir um sistema de feedback completo sobre a infraestrutura do GitHub.

Com o novo sistema, agora você pode criar problemas do GitHub diretamente de uma página de conteúdo, o que permite que você interaja de uma maneira muito mais rica com escritores e equipes de produto. Viu um problema com um documento? Um exemplo de código ruim? Uma explicação confusa? Uma omissão crítica? Basta rolar até a parte inferior da página e selecionar Dar feedback à documentação.

Você pode ver todos os problemas abertos e fechados associados ao documento, diretamente da própria página de documentação - dessa forma, você está sempre ciente quando as coisas são corrigidas e resolvidas:

Você pode comentar e até mesmo adicionar reações a questões que são importantes para você:

Agora, os funcionários da Microsoft podem aproveitar todo o poder dos problemas do GitHub para triar, responder, planejar e corrigir problemas relatados - e você sempre terá visibilidade do processo!

Exemplo de feedback da documentação

Digamos que você registre um problema no GitHub para um hiperlink quebrado em um artigo. Nossa equipe fará a triagem do problema, atribuirá um rótulo e designará um proprietário para fazer a correção (ou fazer perguntas de acompanhamento). Quando o proprietário envia uma solicitação pull que corrige o problema, você será notificado (com base nas configurações de notificação do GitHub) de que o problema foi resolvido/fechado, criando um ciclo virtuoso de feedback.

Além disso, você pode aproveitar toda a bondade padrão do GitHub, como Markdown em comentários, assinaturas de problemas individuais ou repositórios inteiros, feeds RSS da atividade da organização, @menções, cessionários e muito mais! Acreditamos que um nível mais profundo de integração de ferramentas de código aberto irá promover novas oportunidades de crescimento e colaboração da comunidade.

Separação do feedback do produto

Um dos problemas com o sistema anterior era a mistura entre o feedback do produto e da documentação em um fluxo - era extremamente difícil fazer a triagem e o acompanhamento, quando nem todos os itens são rotulados de forma consistente. Demos um passo em frente para resolver este problema, criando uma maneira clara de separar os dois:

Ao clicar Dar feedback sobre o produto, você será levado diretamente para o site onde a equipe de produto associada à página de documentação específica lida com o feedback do produto.

Roll-Out

Você deve estar se perguntando quando o sistema de feedback estará no ar. Estamos testando há alguns meses para o IDE do Visual Studio e a documentação da CLI do Azure. A partir de meados de fevereiro, começaremos a implementar isso em todos os docs.microsoft.com.

Os seus comentários

O seu feedback é importante para nós, por isso queremos ter este novo sistema nas suas mãos rapidamente. Embora seja o nosso próximo passo para melhorar o feedback e o envolvimento na nossa plataforma, não é de forma alguma o nosso último passo. Certifique-se de expressar seus pensamentos sobre as mudanças no GitHub, ou marque-nos no Twitter.