Ein neues Feedbacksystem wird zur docs.microsoft.com
Dieser Beitrag wurde von Rob Eisenberg, Senior Program Manager im docs.microsoft.com Team geschrieben.
Die Mission von Microsoft besteht darin, jede Person und jede Organisation auf dem Planeten zu befähigen, mehr zu erreichen. Dies war einer unserer Überlegungen, da wir docs.microsoft.com auf der geöffneten GitHub-Plattformerstellt haben. Heute nehmen wir es auf die nächste Stufe mit dem Wechsel zu einem neuen GitHub-basierten Dokumentationsfeedback-System.
Inhaltsfeedback auf GitHub
Während sich unsere Dokumentation seit Beginn auf GitHub befindet, verwendet unser Feedbackmechanismus für Inhalte Livefyre für Kommentare zu Artikeln. Während Livefyre eine großartige Kommentarlösung ist, hat es sich als unzureichend für unsere spezifischen Anforderungen erwiesen, was das Nachverfolgen, Zuweisen von Besitzern und die Beibehaltung des Status von Inhaltsproblemen ist, die von Kunden ausgelöst werden.
Wir haben eine Reihe von Möglichkeiten untersucht, um es besser zu machen, aber eine Frage, die einen Großteil unserer Arbeit geführt hat, schien sich zu zeigen: Wenn unsere Dokumentation wie Open-Source-Code behandelt wurde, was würden wir verwenden, um dieses Problem zu lösen? Die Antwort auf die Frage schien offensichtlich: GitHub Issues, daher begannen wir, mit der Integration von GitHub-APIs tiefer in unsere Dokumentationsseiten zu experimentieren, um ein vollständiges Feedbacksystem über die GitHub-Infrastruktur zu erstellen.
Mit dem neuen System können Sie jetzt GitHub-Probleme direkt über eine Inhaltsseite erstellen, mit der Sie mit Autoren und Produktteams viel umfangreicher interagieren können. Sehen Sie ein Problem mit einem Dokument? Ein schlechtes Codebeispiel? Eine verwirrende Erklärung? Eine kritische Auslassung? Scrollen Sie einfach nach unten auf der Seite, und wählen Sie Dokumentationsfeedbackgeben.
Sie können alle offenen und geschlossenen Probleme, die mit dem Dokument verbunden sind, direkt von der Dokumentationsseite selbst sehen – auf diese Weise sind Sie immer im Wissen, wann Dinge behoben und behoben werden:
Sie können Kommentare kommentieren und sogar Reaktionen zu Problemen hinzufügen, die für Sie wichtig sind:
Jetzt können Microsoft-Mitarbeiter die volle Leistungsfähigkeit von GitHub-Problemen nutzen, um gemeldete Probleme zu triagen, zu beantworten, zu planen und zu beheben – und Sie haben immer Einblick in den Prozess!
Beispiel für Feedback zur Dokumentation
Angenommen, Sie geben ein GitHub-Problem für einen fehlerhaften Link in einem Artikel an. Unser Team wird das Problem triagen, eine Bezeichnung zuweisen und einen Besitzer zuweisen, um die Korrektur vorzunehmen (oder Nachverfolgungsfragen zu stellen). Wenn der Besitzer eine Pull-Anforderung sendet, die das Problem behebt, werden Sie benachrichtigt (basierend auf Ihren GitHub-Benachrichtigungseinstellungen), dass das Problem behoben/geschlossen wurde und einen virtuenden Zyklus von Feedback erstellt.
Darüber hinaus können Sie alle standardmäßigen GitHub-Güte nutzen, z. B. Markdown in Kommentaren, Abonnements für einzelne Probleme oder gesamte Repos, RSS-Feeds von Organisationsaktivitäten, @ Erwähnungen, Zuweisende und mehr! Wir glauben, dass eine tiefere Ebene der Integration von Open Source-Tools neue Möglichkeiten für das Wachstum und die Zusammenarbeit der Gemeinschaft fördern wird.
Trennung von Produktfeedback
Eines der Probleme mit dem vorherigen System war die Mischung zwischen Produkt- und Dokumentationsfeedback in einem Datenstrom – es war äußerst schwierig, nachzuverfolgen und nachzuverfolgen, wenn nicht alle Artikel konsistent gekennzeichnet sind. Wir haben einen Schritt nach vorn unternommen, um dieses Problem zu beheben, indem wir eine klare Möglichkeit schaffen, die beiden zu trennen:
Durch Klicken auf Produktfeedbackgeben, gelangen Sie jetzt direkt zur Website, auf der das Produktteam, das der spezifischen Dokumentationsseite zugeordnet ist, das Produktfeedback verarbeitet.
Roll-Out
Vielleicht fragen Sie sich, wann das Feedbacksystem live ist. Wir haben es seit einigen Monaten für die Visual Studio IDE und die Azure CLI-Dokumentationpilotiert. Ab Mitte Februar beginnen wir mit dem Rollout dieses Rollouts für alle docs.microsoft.com.
Ihr Feedback
Ihr Feedback ist uns wichtig, damit wir dieses neue System schnell in Ihre Hände bringen möchten. Obwohl es unser nächster Schritt bei der Verbesserung von Feedback und Engagement auf unserer Plattform ist, ist es nicht unser letzter Schritt. Stellen Sie sicher, dass Sie Ihre Gedanken zu den Änderungen auf GitHubäußern oder uns auf Twittermarkieren.