Ett nytt feedbacksystem kommer till docs.microsoft.com
Det här inlägget skrevs av Rob Eisenberg, Senior Program Manager i docs.microsoft.com team.
Microsofts uppdrag är att ge varje person och varje organisation på planeten möjlighet att uppnå mer. Detta var en av våra överväganden när vi byggt docs.microsoft.com ovanpå den öppna GitHub-plattformen. Idag tar vi det till nästa nivå med övergången till ett nytt GitHub-baserat feedbacksystem för dokumentation.
Innehållsfeedback på GitHub
Vår dokumentation har funnits på GitHub sedan början, men vår mekanism för innehållsfeedback har använt Livefyre för kommentarer om artiklar. Även om Livefyre är en bra kommentarslösning visade det sig vara otillräckligt för våra specifika behov, vilket är att spåra, tilldela ägare och underhålla tillståndet för innehållsproblem som tas upp av kunder.
Vi utforskade ett antal vägar för att göra det bättre, men en fråga som har väglett mycket av vårt arbete tycktes dyka upp igen: Om vår dokumentation behandlades precis som öppen källkod, vad skulle vi använda för att lösa detta problem? Svaret på frågan verkade uppenbart: GitHub-problem, så vi började experimentera med att integrera GitHub-API:er djupare i våra dokumentationssidor och kunde skapa ett fullständigt feedbacksystem ovanpå GitHub-infrastrukturen.
Med det nya systemet kan du nu skapa GitHub-problem direkt från en innehållssida, vilket gör att du kan interagera på ett mycket rikare sätt med författare och produktteam. Ser du ett problem med ett dokument? Ett dåligt kodexempel? En förvirrande förklaring? Ett kritiskt utelämnande? Rulla bara längst ned på sidan och välj Ge dokumentationsfeedback.
Du kan se alla öppna och stängda problem som är kopplade till dokumentet, direkt från själva dokumentationssidan – på så sätt vet du alltid när saker och ting åtgärdas:
Du kan kommentera och till och med lägga till reaktioner på problem som är viktiga för dig:
Nu kan Microsoft-anställda utnyttja den fulla kraften i GitHub-problem för att sortera, svara, planera och åtgärda rapporterade problem – och du kommer alltid att ha insyn i processen!
Exempel på feedback om dokumentation
Anta att du skickar ett GitHub-problem för en bruten hyperlänk i en artikel. Vårt team kommer att sortera problemet, tilldela en etikett och tilldela en ägare för att göra korrigeringen (eller ställa uppföljningsfrågor). När ägaren skickar en pull-begäran som åtgärdar problemet får du ett meddelande (baserat på dina GitHub-meddelandeinställningar) om att problemet har lösts/stängts, vilket skapar en god feedbackcykel.
Dessutom kan du utnyttja alla vanliga GitHub-godheter, till exempel Markdown i kommentarer, prenumerationer på enskilda problem eller hela lagringsplatser, RSS-feeds för organisationsaktivitet, @ omnämnanden, tilldelningar med mera! Vi tror att en djupare nivå av integrering av verktyg med öppen källkod kommer att främja nya möjligheter för communityns tillväxt och samarbete.
Separation av produktfeedback
Ett av problemen med det tidigare systemet var mixen mellan produkt- och dokumentationsfeedback i en ström – det var extremt svårt att sortera och följa upp, när inte alla objekt är konsekvent märkta. Vi tog ett steg framåt för att åtgärda problemet genom att skapa ett tydligt sätt att separera de två:
Genom att klicka på Ge produktfeedbackkommer du nu att tas direkt till den webbplats där produktteamet som är associerade med den specifika dokumentationssidan hanterar produktfeedback.
Roll-Out
Du kanske undrar när feedbacksystemet kommer att vara live. Vi har pilottestat det i ett par månader nu för Visual Studio IDE- och Azure CLI-dokumentationen. Från och med mitten av februari börjar vi lansera detta i alla docs.microsoft.com.
Din feedback
Din feedback är viktig för oss, så vi vill få det här nya systemet i dina händer snabbt. Även om det är vårt nästa steg för att förbättra feedback och engagemang på vår plattform är det inte på något sätt vårt sista steg. Var noga med att uttrycka dina tankar om de ändringar som på GitHub, eller tagga oss på Twitter.