Připravuje se nový systém zpětné vazby docs.microsoft.com
Tento příspěvek napsal Rob Eisenberg, vedoucí programový manažer v týmu docs.microsoft.com.
Cílem Microsoftu je umožnit každému člověku a každé organizaci na planetě dosáhnout více. To byl jeden z našich aspektů, když jsme vytvořili docs.microsoft.com nad otevřenou platformou GitHub. V současné chvíli přejdeme na další úroveň s přechodem na nový systém zpětné vazby dokumentace založený na GitHubu.
Zpětná vazba k obsahu na GitHubu
Naše dokumentace je na GitHubu od začátku, ale náš mechanismus zpětné vazby k obsahu používá Livefyre pro komentáře k článkům. I když je Livefyre skvělým řešením pro komentování, ukázalo se, že není dostatečná pro naše konkrétní potřeby, což je sledovat, přiřazovat vlastníky a udržovat stav problémů s obsahem vyvolaných zákazníky.
Prozkoumali jsme celou řadu způsobů, jak to vylepšit, ale jedna otázka, která vedla většinu naší práce, se zdálo, že se znovu objevila: Pokud by byla naše dokumentace považována za opensourcový kód, co bychom použili k vyřešení tohoto problému? Odpověď na otázku se zdálo zřejmé: problémy GitHubu, takže jsme začali experimentovat s integrací rozhraní API GitHubu hlouběji do našich stránek dokumentace, takže jsme mohli vytvořit kompletní systém zpětné vazby nad infrastrukturou GitHubu.
S novým systémem teď můžete vytvářet problémy GitHubu přímo ze stránky obsahu, která umožňuje pracovat mnohem bohatším způsobem se spisovateli a produktovými týmy. Vidíte problém s dokumentem? Chybný vzorový kód? Matoucí vysvětlení? Zásadní vynechání? Jednoduše se posuňte do dolní části stránky a vyberte Poslat zpětnou vazbu k dokumentaci.
Všechny otevřené a zavřené problémy související s dokumentem můžete zobrazit přímo ze samotné stránky dokumentace – to znamená, že vždy víte, kdy se věci opraví a vyřeší:
Můžete komentovat a dokonce přidávat reakce k problémům, které jsou pro vás důležité:
Zaměstnanci Microsoftu teď můžou využít plnou sílu githubových problémů ke třídění, reagování, plánování a řešení nahlášených problémů – a vždy budete mít přehled o procesu.
Příklad zpětné vazby k dokumentaci
Řekněme, že vytvoříte problém GitHubu s poškozeným hypertextovým odkazem v článku. Náš tým určí prioritu problému, přiřadí popisek a přiřadí vlastníka, aby opravu provedl (nebo se ptejte na další otázky). Když vlastník odešle žádost o přijetí změn, která problém opraví, dostanete oznámení (na základě nastavení oznámení GitHubu), že se problém vyřešil nebo zavřel a vytvořil cyklus zpětné vazby.
Kromě toho můžete využít veškerou standardní dobrotu GitHubu, jako je Markdown v komentářích, odběry jednotlivých problémů nebo celých úložišť, informační kanály RSS aktivit organizace, @ zmínky, přiřazování a další! Věříme, že hlubší úroveň integrace opensourcových nástrojů bude podporovat nové příležitosti pro růst a spolupráci komunity.
Oddělení zpětné vazby k produktům
Jedním z problémů s předchozím systémem byla kombinace zpětné vazby k produktům a dokumentaci v jednom datovém proudu – bylo velmi těžké určit prioritu a zpracovat, pokud nejsou všechny položky konzistentně označené. Rozhodli jsme se tento problém vyřešit vytvořením jasného způsobu, jak tyto dva oddělit:
Kliknutím na Poskytnout zpětnou vazbu k produktubudete nyní přesměrováni přímo na web, kde produktový tým přidružený ke konkrétní stránce dokumentace zpracovává zpětnou vazbu k produktu.
Roll-Out
Možná vás zajímá, kdy bude systém zpětné vazby aktivní. Na pár měsíců jsme ho pilotovali pro integrované vývojové prostředí sady Visual Studio a dokumentaci k Azure CLI. Od poloviny února začneme tento postup zavádět ve všech docs.microsoft.com.
Váš názor
Vaše zpětná vazba je pro nás důležitá, takže chceme tento nový systém rychle dostat do rukou. I když se jedná o náš další krok v oblasti zlepšování zpětné vazby a zapojení na naší platformě, není to v žádném případě naším posledním krokem. Nezapomeňte označit své myšlenky o změnách na GitHubu, nebo nás označovat na Twitteru.