Egy új visszajelzési rendszer várható a docs.microsoft.com webhelyen
Ezt a közleményt Rob Eisenberg, a docs.microsoft.com csapat vezető programmenedzsere írta.
A Microsoft alapvető célja, hogy a bolygón minden ember és vállalat nagyobb eredményeket érhessen el. Ez volt az egyik szempont, amikor a nyitott GitHub platformon felépítettük a docs.microsoft.com webhelyet. Ma egy újabb szintre váltunk azzal, hogy áttérünk egy új GitHub-alapú dokumentációs visszajelzési rendszerre.
Tartalommal kapcsolatos visszajelzés a GitHubon
Bár a dokumentációnk a kezdetektől a GitHubon volt elérhető, a tartalommal kapcsolatos visszajelzési rendszer a Livefyre-t használta a cikkekkel kapcsolatos megjegyzésekhez. A Livefyre ugyan nagyszerű megoldás megjegyzések írásához, de a speciális igényeink, tehát a nyomon követés, tulajdonosok hozzárendelése és az ügyfelek által a tartalommal kapcsolatban felvetett problémák állapotának megtartása, szempontjából nem bizonyult elégségesnek.
Több utat is megvizsgáltunk annak érdekében, hogy jobbá tegyük, de úgy tűnt, hogy a munkánk nagy részét irányító kérdés újra előkerült: Ha a dokumentációt ugyanúgy kezelik, mint nyílt forráskód kódot, mit használnánk a probléma megoldásához? A kérdésre adott válasz nyilvánvalónak tűnt: GitHub-problémák, ezért elkezdtünk kísérletezni a GitHub API-k mélyebb integrálásával a dokumentációs oldalainkon, hogy teljes visszajelzési rendszert tudjunk létrehozni a GitHub-infrastruktúra tetején.
Az új rendszerben közvetlenül a tartalomoldalról lehet GitHub-problémákat létrehozni, ami sokkal szerteágazóbb együttműködést tesz lehetővé az írókkal és a termékcsapatokkal. Problémát tapasztalt egy dokumentummal kapcsolatban? Rossz kódminta? Zavaros magyarázat? Egy kritikus fontosságú kihagyás? Csak görgessen a lap aljára, és válassza a Give documentation feedback (Dokumentációval kapcsolatos visszajelzés) lehetőséget.
Láthatja közvetlenül a dokumentációs oldalról a dokumentumhoz társított összes nyitott vagy lezárt problémát – ezáltal mindig értesül róla, amikor a problémákat megoldják vagy a hibákat kijavítják:
Megjegyzéseket fűzhet az Ön számára fontos problémákhoz, vagy akár reagálhat is rájuk:
A Microsoft alkalmazottai most már teljes egészében kihasználhatják a GitHub Issues nyújtotta előnyöket a jelentett problémák osztályozásához, megválaszolásához, tervezéséhez és megoldásához – és a folyamat mindig átlátható lesz!
Példa dokumentációval kapcsolatos visszajelzésre
Tegyük fel, hogy bejelent egy cikk nem működő hivatkozásával kapcsolatos GitHub-problémát. Csapatunk osztályozza a problémát, hozzárendel egy címkét, valamint egy tulajdonost a javítás elvégzéséhez (vagy követő kérdéseket tesz fel). Ha a tulajdonos beküld egy lekéréses kérelmet, amely megoldja a problémát, akkor Ön értesítést kap (a GitHub értesítési beállításainak megfelelően), hogy a problémát megoldották/lezárták, ezáltal pozitív visszajelzési ciklus alakul ki.
Emellett kihasználhatja a GitHub minden szokásos előnyét, például a megjegyzésekben a Markdown használatát, feliratkozást egyes problémákra vagy teljes problématárra, a szervezeti tevékenységek RSS-hírcsatornáit, az @említéseket, a hozzárendelteket és sok egyebet! Úgy véljük, hogy a nyílt forráskódú eszközök mélyebb integrációja új lehetőségeket teremt a közösség növelése és az együttműködés terén.
A termékvisszajelzések elválasztása
A korábbi rendszer problémáinak egyike a termékekkel és a dokumentációval kapcsolatos visszajelzések keveredése volt ugyanabban a streamben – rendkívül nehézkes az osztályozás és a nyomon követés, ha nem minden elem címkézése konzisztens. Tettünk előre egy lépést a probléma megoldásában létrehozva egy világos módszer a kettő elválasztásához:
Ha a Give product feedback (Termékkel kapcsolatos visszajelzés) elemre kattint, akkor most már közvetlenül arra a webhelyre fog jutni, ahol a meghatározott dokumentációs oldalhoz társított termékcsapat a termékkel kapcsolatos visszajelzéseket kezeli.
Bevezetés
Felmerülhet Önben a kérdés, mikortól lesz élő a visszajelzési rendszer. Már néhány hónapja folyamatban van a kipróbálása a Visual Studio IDE és az Azure CLI-dokumentáció esetében. Februártól közepétől kezdve meg fogjuk kezdeni a bevezetését minden docs.microsoft.com webhelyen.
Az Ön visszajelzése
A visszajelzése fontos a számunkra, ezért szeretnénk ezt az új rendszert gyorsan üzembe helyezni. Habár ez a következő lépés a visszajelzés és elköteleződés javítása érdekében a platformunkon, semmi esetre sem az utolsó lépés. A GitHubon mindenképpen jelezheti gondolatait a változásokról, vagy címkézhet meg minket a Twitteren.