Microsoft Docs

Microsoft docs on Github

Microsoft’s mission is to empower every person and every organization on the planet to achieve more. This was one of MS considerations as they built docs.microsoft.com on top of the open GitHub platform. The next step was to move to a new GitHub-based documentation feedback system.

While MS documentation has been on GitHub since the beginning, the content feedback mechanism has been using Livefyre for comments on articles. While Livefyre is a great commenting solution, it turned out to be insufficient for specific needs, which is to track, assign owners, and maintain the state of content issues raised by customers. MS explored a number of avenues to make it better, but one question that has guided much of the work seemed to resurface: If the documentation were treated just like open source code, what would MS use to solve this problem? The answer to the question seemed obvious: GitHub Issues, so MS began to experiment with integrating GitHub APIs more deeply into the documentation pages, being able to build a full feedback system on top of the GitHub infrastructure.

With the new system, users can now create GitHub issues directly from a content page, which enables users to interact in a much richer way with writers and product teams. See an issue with a document? A bad code sample? A confusing explanation? A critical omission? Just scroll to the bottom of the page and select Give documentation feedback.

User logging in and leaving feedback

Source: https://docs.microsoft.com/en-us/teamblog/a-new-feedback-system-is-coming-to-docs 

 

About The Author