Bemutatkozik a docs.microsoft.com

A bejegyzést Jeff Sandquist, a Cloud + Enterprise részleg vezérigazgatója írta.

Ma jelentjük be az új dokumentációs szolgáltatás https://docs.microsoft.comelőzetes kiadását, amely bemutatja a nagyvállalati mobilitási termékeinket támogató tartalmakat.

Mi indokolta a docs.microsoft.com létrehozását?

Röviden szólva, a tartalom fontossága. Több száz fejlesztő és informatikai szakember körében végeztünk felméréseket, valamint több év UserVoice-visszajelzéseit vettük górcső alá. Nyilvánvalóvá vált, hogy változtatnunk kell, és létre kell hoznunk egy modern webes tartalom-közzétételi környezetet. Első lépésként kiértékeltük meglévő tartalom-infrastruktúránkat, a TechNet-et és az MSDN-t. Mindkét webhely egy olyan 10-15 éves, törékeny kódbázisra és elavult közzétételi rendszerre épült, amelyet nem felhőbeli használatra terveztek.

Figyelmünket nem csak a felhasználói környezetre összpontosítottuk, hanem az általunk létrehozott tartalomra és a tartalomfogyasztói szokásokra is. Ügyfeleink évek óta jelzik, hogy szöveghegyek helyett olyan szolgáltatásszintű tartalmat biztosítsunk a számukra, amely segítséget nyújt az üzleti problémáikra megoldást kínáló termékek használatához. Tudtuk tehát, hogy az általunk közvetített tartalomnak és az általunk létrehozott platformnak meg kell könnyítenie ügyfeleink számára a megoldások megismerését és alkalmazását.

Rájöttünk, hogy a megfelelő eredmény elérése érdekében az építkezést az alapoktól kell kezdenünk. Így született meg a https://docs.microsoft.com, a Microsoft új dokumentációs víziója.

Megjegyzés: A webhely ezen előzetes kiadása *csak* tartalommal rendelkezik a nagyvállalati mobilitási dokumentációhoz (amely az Advanced Threat Analytics, az Azure Active Directory, az Azure Remote App, a Többtényezős hitelesítés, a Azure Tartalomvédelmi szolgáltatások, a Intune és a Microsoft Identity Manager). A későbbiekben, amint platformunk az ügyfél-visszajelzéseknek is köszönhetően kiforrottabb lesz, további dokumentációkat is elérhetővé teszünk ezen a webhelyen.

A legfontosabb jellemzők

Kezdjük az alábbi példadokumentációval, és bemutatunk néhány új funkciót a webhelyen.

Példa dokumentációs weblapra

Olvashatóság

A könnyebb olvashatóság érdekében rögzítettük a tartalomszélességet a webhelyen. A szemkövető vizsgálatok kimutatták, hogy a tartalomszélesség beállításával javíthatja a megértést és az olvasási sebességet, mivel a szem nehezen tudja követni a hosszú, balról jobbra haladó szakaszokat. Ezt szemlélteti a valós életből vett alábbi példa is, amelyben egy Intune-cikk TechNet-es és docs.microsoft.com webhelyen közzétett változata látható. Növeltük a bal oldali navigáció betűméretét és magát a szöveget is, amit az ügyfelek kértek (UserVoice – Betűméret növelése).

A Docs és a TechNet összehasonlítása

Becsült olvasási idő

Egy másik egyszerű fejlesztés, amelyet a bemenete alapján végeztünk el, az a cikk becsült olvasási idejének biztosítása. Tudjuk, hogy sokan néhány perc alatt tanulnak/értékelnek technológiát az értekezletek között, és nagyobb valószínűséggel olvassanak el cikkeket, ha tudnák, hogy mennyi időre van szükség. Közöljük a tartalom közzétételének dátumát is, így ügyfeleink azzal is tisztában lehetnek, hogy mennyire frissek a cikkben szereplő információk a UserVoice-visszajelzésekhez képest.

Becsült olvasási idő

Navigálás a tartalomban és a webhelyen

Az ügyfélinterjúkon és a UserVoice-visszajelzéseken alapuló befektetések egyik fő területe a webhely-navigáció, az információs architektúra és a tartalomszervezés fejlesztése volt az ügyfél szándéka alapján. A tartalmat a következő főbb szempontok alapján rendszereztük újra: kiértékelés, kezdeti lépések, tervezés, üzembe helyezés, kezelés, valamint a termékek vagy szolgáltatások hibaelhárítása. Ez a tartalomfelosztási koncepció érvényesül mind a bal oldali navigációs területen, mind a termék- és szolgáltatáslapokon.

Az alábbi képernyőfelvételen az Intune-dokumentáció kezdőlapja látható:

Az Intune-dokumentációs képernyőképe

Ugyanezek a kategóriák jelennek meg a cikkek bal oldali navigációs sávján is:

Bal oldali navigációs sáv

Rövidebb cikkek

Egy másik gyakori visszajelzés az volt, hogy a tartalom időnként elsöprő lehet a hossza miatt, és hogy a hosszú cikkek nehezebben navigálnak, és megtalálják, amit keresnek. A probléma megoldásához sok hosszabb cikket kisebb logikai lépésekre bontottunk, és a cikkek alján az Előző és a Következő gombot biztosítottuk a többrészes oktatóanyag lépései közötti navigáláshoz az alább látható módon.

Vissza és Tovább gomb

Míg számos ügyfél kedveli a többrészes oktatóanyagokat, azt is kérték egyes ügyfelek, hogy a többrészes oktatóanyagokat egyetlen, kapcsolat nélkül nyomtatható PDF-fájlban lehessen kombinálni. Ez a funkció hamarosan elérhető lesz az előzetes verzióban.

Rugalmas kialakítás

Annak érdekében, hogy a mobileszközökön, a táblagépeken és a PC-ken egyaránt azonos színvonalú szolgáltatást nyújthassunk, a UserVoice-kéréseknek megfelelően rugalmas elrendezést alakítottunk ki. A Lehetőségek gombra kattintva ugyanazok a vezérlőelemek asztali nézetben megjeleníthetők vagy elrejthetők.

Rugalmas lapelrendezés

Közösségi hozzájárulások

A docs.microsoft.com webhelyen elérhető összes dokumentáció nyílt forráskódú, és a közösségek által szabadon szerkeszthető. Ezzel a Microsoft azon fejlesztőcsapatainak nyomdokába léptünk, amelyek már teljes egészében vagy részben nyílt forráskódúvá tették dokumentációjukat, beleértve az ASP.NET-et, az Azure-t, a .NET Core-t és a Microsoft Graph-ot.

Minden cikkben megtalálható az alábbiakban is látható Szerkesztés gomb, amelyre kattintva megnyílik az adott cikk Markdown-forrásfájlja a GitHub webhelyen, ahol könnyedén beküldhető egy tartalomjavítási kérelem.

Visszajelzési mechanizmusok

Kérdései, megjegyzései és visszajelzései fontosak a számunkra. Az összes cikkünkhöz [Livefyre](https://web.livefyre.com/) megjegyzéseket és mellékjegyzeteket is mellékeltünk. Minden cikk tetején megjelenik egy hivatkozás a megjegyzésekhez az alább látható módon.

Megjegyzések hivatkozás

E hivatkozásra kattintva a lap aljára ugorhat, ahol bejelentkezhet Twitter-, Facebook-, Google-, Yahoo- vagy Microsoft-fiókjának hitelesítő adataival, és hozzáadhatja saját megjegyzéseit, illetve követheti vagy kedvelheti másokéit).

Alsó megjegyzések

A tartalom minden bekezdéséhez vagy a kifejezetten ebből a célból kiemelt szövegrészéhez is fűzhet megjegyzést, vagy készíthet széljegyzetet. Ehhez kattintson a jobb oldalon található megjegyzésszimbólumra.

Példa a széljegyzetre

Közösségi megosztás

A megosztás gombja, amely a lap tetején található, lehetővé teszi az adott tartalom megosztását a Twitteren és a Facebookon.

Megosztás a Twitteren és a Facebookon

Mindezt a kívánt tartalomrészt kijelölve közvetlenül a helyi menüből is elvégezheti, az alábbi képen látható módon.

Kijelölés és megjegyzéskészítés vagy tartalommegosztás

Böngészőbarát URL-címek

Ügyelünk a webes felhasználói környezettel kapcsolatos részletekre is: TechNet- és MSDN-felhasználóként már régóta bosszankodunk amiatt, hogy a cikkek URL-címei nem használhatók kényelmesen a böngészőkben. Íme egy példa erre a cikkre az új URL-címekkel.

  • Előtt:<https://technet.microsoft.com/library/dn646983.aspx>

  • Után:<https://docs.microsoft.com/intune/get-started/start-with-a-paid-subscription-to-microsoft-intune>

Webhelytémák

A cikkeket kiegészítettük egy témaválasztóval is, így választani lehet egy világos és egy sötét téma közül – ezt többen kérték a UserVoice-on.

Választható világos vagy sötét téma

Az alábbi kép a világos és a sötét téma közötti különbséget szemlélteti.

A világos és a sötét téma

Alapismeretek

Az alapvető jellemzőkre, például a webhely teljesítményére nagy hangsúlyt fektettünk, mert ezek fejlesztését számos ügyfelünk kérte a UserVoice webhelyen. Lapbetöltési idő a docs.microsoft.com webhelyen 50–300%-kal rövidebb a korábbinál, a szolgáltatás földrajzi eloszlása pedig minden eddiginél jobb. Egy olyan architektúrára is építettünk, amely 100%-ban fut az Azure-ban.

Szívesen fogadjuk visszajelzését!

Reméljük, hogy hasznosnak találta a docs.microsoft.com előzetes verzióját, és várjuk visszajelzését a https://aka.ms/sitefeedback címre. A jövőbeli bejegyzésekben a referenciatartalmak élményének drámai javítását célzó terveinket és a tartalom honosítási terveit tárgyaljuk.