Új visszajelzési rendszer érkezik docs.microsoft.com
Ezt a bejegyzést Rob Eisenberg, a docs.microsoft.com csapat vezető programvezetője írta.
A Microsoft küldetése, hogy a világ minden emberét és szervezetét nagyobb hatékonyságra tegye képessé. Ez volt az egyik szempontunk, mivel docs.microsoft.com a megnyitott GitHub platform. Ma egy új GitHub-alapú dokumentációs visszajelzési rendszerre való áttéréssel a következő szintre lépünk.
Tartalomvisszajelzés a GitHubról
Bár a dokumentációnk a kezdetek óta a GitHubon van, a tartalomvisszajelzési mechanizmusunk a Livefyre-t használja a cikkekhez fűzött megjegyzésekhez. Bár a Livefyre egy nagyszerű megjegyzéskezelési megoldás, kiderült, hogy nem felel meg az igényeinknek, ami a tulajdonosok nyomon követése, hozzárendelése és az ügyfelek által felvetett tartalomproblémák állapotának fenntartása.
Több utat is megvizsgáltunk, hogy jobb legyen, de úgy tűnt, hogy egy kérdés, amely a munkánk nagy részét irányította, úgy tűnt, hogy újra előkerül: Ha a dokumentációt ugyanúgy kezelik, mint a 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 lapjainkba, hogy teljes visszajelzési rendszert építhessünk ki a GitHub-infrastruktúra tetejére.
Az új rendszerrel mostantól közvetlenül egy tartalomoldalról hozhat létre GitHub-problémákat, így sokkal gazdagabb módon kommunikálhat az írókkal és a termékcsapatokkal. Dokumentummal kapcsolatos probléma jelenik meg? Rossz kódminta? Egy zavaros magyarázat? Kritikus mulasztás? Csak görgessen az oldal aljára, és válassza a Dokumentációs visszajelzés küldéselehetőséget.
A dokumentumhoz kapcsolódó összes nyitott és lezárt problémát közvetlenül a dokumentációs oldalról láthatja , így mindig tudhatja, hogy mikor javítják ki és oldják meg a problémákat:
Megjegyzéseket fűzhet hozzá, és még is hozzáadhat reakciókat az Ön számára fontos problémákhoz:
A Microsoft alkalmazottai mostantól a GitHub-problémák teljes erejét kihasználhatják a jelentett problémák osztályozására, megválaszolására, megtervezésére és megoldására , és ön mindig láthatja a folyamatot!
Példa dokumentációs visszajelzésre
Tegyük fel, hogy gitHub-problémát ad egy cikk hibás hivatkozásához. Csapatunk elosztja a problémát, hozzárendel egy címkét, és hozzárendel egy tulajdonost a javítás elvégzéséhez (vagy felteheti a következő kérdéseket). Amikor a tulajdonos elküld egy lekéréses kérelmet, amely megoldja a problémát, értesítést kap (a GitHub értesítési beállításai alapján), hogy a probléma megoldódott/lezárult, és a visszajelzések erényes ciklusát hozza létre.
Emellett kihasználhatja az összes szokásos GitHub-jóságot, például a Markdownt a megjegyzésekben, az előfizetéseket az egyes problémákhoz vagy a teljes adattárakhoz, a szervezeti tevékenység RSS-hírcsatornáit, @ említéseket, hozzárendeléseket stb. Úgy gondoljuk, hogy a nyílt forráskódú eszközök integrációjának mélyebb szintje új lehetőségeket teremt a közösség növekedésére és együttműködésére.
A termékvisszajelzések elkülönítése
Az előző rendszerrel kapcsolatos egyik probléma a termék- és dokumentációs visszajelzések keveredése volt egy streamben – rendkívül nehéz volt a osztályozás és a nyomon követés, amikor nem minden elem címkéje következetesen. A probléma megoldásához egy lépéssel előrehaladtunk, és egyértelmű módot hoztunk létre a kettő elválasztására:
A Termékvisszajelzés küldésegombra kattintva közvetlenül arra a webhelyre kerül, ahol az adott dokumentációs oldalhoz társított termékcsapat kezeli a termékvisszajelzéseket.
Roll-Out
Felmerülhet a kérdés, hogy mikor lesz élő a visszajelzési rendszer. Néhány hónapja teszteljük a Visual Studio IDE és a Azure CLI dokumentációját. Február közepétől kezdve ezt az egész docs.microsoft.com elkezdjük.
Az Ön visszajelzése
Visszajelzése fontos számunkra, ezért szeretnénk gyorsan a kezébe venni ezt az új rendszert. Bár ez a következő lépésünk a visszajelzések és a platformon való részvétel javításában, ez egyáltalán nem az utolsó lépésünk. A GitHub változásaival kapcsolatos gondolatait, illetve a Twitter címkével lássa el.