Er komt een nieuw feedbacksysteem naar docs.microsoft.com

Dit bericht is geschreven door Rob Eisenberg, Senior Program Manager in het docs.microsoft.com team.

De missie van Microsoft is om iedereen en elke organisatie op de planeet in staat te stellen meer te bereiken. Dit was een van onze overwegingen toen we docs.microsoft.com gebouwd boven op het open GitHub-platform. Vandaag gaan we het naar het volgende niveau met de overstap naar een nieuw feedbacksysteem voor documentatie op Basis van GitHub.

Feedback over inhoud op GitHub

Hoewel onze documentatie al sinds het begin op GitHub is, gebruikt ons feedbackmechanisme voor inhoud Livefyre voor opmerkingen over artikelen. Hoewel Livefyre een uitstekende oplossing voor opmerkingen is, bleek het onvoldoende te zijn voor onze specifieke behoeften, namelijk om eigenaren bij te houden, toe te wijzen en de status van inhoudsproblemen te behouden die door klanten worden veroorzaakt.

We hebben een aantal manieren verkend om het beter te maken, maar een vraag die veel van ons werk heeft geleid, leek opnieuw op te lossen: Als onze documentatie net als opensource-code werd behandeld, wat zouden we gebruiken om dit probleem op te lossen? Het antwoord op de vraag leek duidelijk: GitHub Issues, dus we begonnen te experimenteren met het integreren van GitHub-API's in onze documentatiepagina's, waardoor we een volledig feedbacksysteem kunnen bouwen boven op de GitHub-infrastructuur.

Met het nieuwe systeem kunt u nu rechtstreeks gitHub-problemen maken vanaf een inhoudspagina, zodat u op een veel rijkere manier kunt communiceren met schrijvers en productteams. Ziet u een probleem met een document? Een slecht codevoorbeeld? Een verwarrende uitleg? Een kritieke weglating? Schuif naar de onderkant van de pagina en selecteer Feedback over documentatie geven.

U kunt alle geopende en gesloten problemen zien die zijn gekoppeld aan het document, rechtstreeks vanaf de documentatiepagina zelf, zodat u altijd op de hoogte bent wanneer er problemen zijn opgelost en opgelost:

U kunt opmerkingen maken en zelfs reacties toevoegen aan problemen die belangrijk voor u zijn:

Microsoft-medewerkers kunnen nu gebruikmaken van de volledige kracht van GitHub-problemen om gerapporteerde problemen te orden, te beantwoorden, te plannen en op te lossen. U hebt altijd inzicht in het proces.

Voorbeeld van documentatiefeedback

Stel dat u een GitHub-probleem optekent voor een verbroken hyperlink in een artikel. Ons team sorteert het probleem, wijst een label toe en wijst een eigenaar toe om de oplossing te maken (of vervolgvragen te stellen). Wanneer de eigenaar een pull-aanvraag indient waarmee het probleem wordt opgelost, ontvangt u een melding (op basis van uw GitHub-meldingsinstellingen) dat het probleem is opgelost/gesloten, waardoor er een positieve feedbackcyclus ontstaat.

Daarnaast kunt u gebruikmaken van alle standaard GitHub-goedheid, zoals Markdown in opmerkingen, abonnementen op afzonderlijke problemen of volledige opslagplaatsen, RSS-feeds van organisatieactiviteiten, @vermeldingen, toegewezen personen en meer! We zijn van mening dat een dieper niveau van opensource-hulpprogramma-integratie nieuwe mogelijkheden voor groei en samenwerking in de community zal bevorderen.

Scheiding van productfeedback

Een van de problemen met het vorige systeem was de combinatie tussen product- en documentatiefeedback in één stroom: het was zeer moeilijk om te triage en opvolgen, wanneer niet alle items consistent worden gelabeld. We hebben een stap voorwaarts gezet om dit probleem op te lossen door een duidelijke manier te maken om de twee te scheiden:

Door te klikken op Feedback over producten geven, wordt u nu rechtstreeks naar de site geleid waar het productteam dat is gekoppeld aan de specifieke documentatiepagina productfeedback verwerkt.

Roll-Out

U vraagt zich misschien af wanneer het feedbacksysteem live zal zijn. We hebben het nu al een paar maanden testen voor de Visual Studio IDE- en de Azure CLI-documentatie. Vanaf half februari beginnen we met het implementeren van dit alles in docs.microsoft.com.

Uw feedback

Uw feedback is belangrijk voor ons, dus we willen dit nieuwe systeem snel in uw handen krijgen. Hoewel het onze volgende stap is bij het verbeteren van feedback en betrokkenheid op ons platform, is het niet onze laatste stap. Zorg ervoor dat u uw gedachten over de wijzigingen op GitHub, of tag ons op Twitter.