Web docs.microsoft.com začíná používat nový systém pro zpětnou vazbu
Autorem tohoto příspěvku je Rob Eisenberg, vedoucí programový manažer v týmu docs.microsoft.com.
Cílem společnosti Microsoft je pomoct každému člověku a každé organizaci na zemi, aby toho dokázali víc. To byla jedna z věcí, kterou jsme měli na paměti, když jsme budovali docs.microsoft.com v rámci otevřené platformy GitHub. Dnes přecházíme na vyšší úroveň a přesouváme se na nový systém pro zpětnou vazbu založený na GitHubu.
Zpětná vazba k obsahu na GitHubu
Naše dokumentace byla na GitHubu od začátku, ale jako mechanismus zpětné vazby jsme využívali Livefyre pro komentáře ke článkům. Livefyre je skvělé řešení pro komentáře, ukázalo se ale, že se nehodí pro naše konkrétní potřeby: sledovat problémy s obsahem, které nám zákazníci nahlásí, přiřazovat odpovědnost za jejich vyřešení a průběžně aktualizovat jejich stav.
Prozkoumali jsme řadu možností, jak ji vylepšit, ale jedna otázka, která vedla k velké části naší práce, se objevila znovu: Pokud by se s naší dokumentací zacházelo stejně jako s open source kódem, co bychom použili k vyřešení tohoto problému? Odpověď na otázku se zdála být zřejmá: Problémy s GitHubem, takže jsme začali experimentovat s hlubší integrací rozhraní API GitHubu do našich stránek dokumentace a mohli jsme vytvořit kompletní systém zpětné vazby nad infrastrukturou GitHubu.
S novým systémem máte možnost vytvořit oznámení GitHubu o problémech přímo ze stránky obsahu, což značně rozšiřuje vaše možnosti interakce s autory a produkčním týmem. Máte s dokumentem problém? Chybný vzorový kód? Matoucí vysvětlení? Zásadní opomenutí? Stačí se přesunout do spodní části stránky a vybrat odkaz Názor na obsah.
Všechny otevřené a uzavřené problémy související s dokumentem se zobrazí přímo ze stránky dokumentace a vy tak vždycky budete vědět, až se záležitost vyřeší a uzavře:
Můžete přidávat komentáře a dokonce i reakce k problémům, které jsou pro vás důležité:
Zaměstnanci Microsoftu teď můžou využít všechny možnosti, které GitHub Issues nabízí, k určení priorit podle dostupnosti zdrojů, plánování a řešení nahlášených problémů – a vy můžete celý proces sledovat!
Příklad zpětné vazby k dokumentaci
Řekněme, že oznámíte v GitHubu problém, kterým je přerušený hypertextový odkaz v článku. Náš tým určí prioritu problému, přiřadí mu popisek a přiřadí k němu člověka odpovědného za nápravu (nebo se na vás obrátí s doplňujícími dotazy). Jakmile se problém opraví a odešle se žádost o přijetí změn, dostanete oznámení (v závislosti na tom, jak máte nastavená oznámení v GitHubu), že byl problém vyřešen/uzavřen, a tím se celý cyklus zpětné vazby dokončí.
Kromě toho můžete využívat všechny standardní výhody GitHubu, jako například Markdown v komentářích, odběr konkrétních problémů nebo celých úložišť, informační kanály RSS ohledně aktivity organizace, @zmínky, pověřené osoby a tak dál! Jsme přesvědčení, že větší integrace nástrojů s otevřeným zdrojem podpoří nové možnosti pro růst a spolupráci komunity.
Oddělení zpětné vazby k produktům
Jedním z nedostatků předchozího systému bylo smíšení zpětné vazby k produktům a k dokumentaci v jednom datovém proudu. Ne všechny položky byly přitom jednotně popsané a bylo tak velice těžké určit prioritu a zajistit následnou kontrolu. Tento problém jsme se rozhodli vyřešit vytvořením jasného předělu mezi oběma druhy zpětné vazby:
Po kliknutí na odkaz Názor na produkt přejdete přímo na stránku, kde produktový tým přidružený ke konkrétní stránce dokumentace spravuje zpětnou vazbu k produktům.
Spuštění
Možná se ptáte, kdy systém pro zpětnou vazbu spustíme. Už několik měsíců běží pilotní nasazení pro integrované vývojové prostředí sady Visual Studio a dokumentaci Azure CLI. Od poloviny února začneme tento systém zavádět na celém webu docs.microsoft.com.
Váš názor
Váš názor je pro nás důležitý, proto vám chceme dát tento nový systém k dispozici co nejdříve. Jedná se o další krok ve zlepšování zpětné vazby a zapojení na naší platformě, zdaleka to ale není krok poslední. Nezapomeňte nám o změnách na GitHubu nebo nás na Twitteru označit.