👋 Nový obsah na borekb.cz

Info Tento blog je v "read-only módu" a nový obsah již nebude přibývat. O vývoji píšu na DevBlog.

Dokumentace v podání Microsoftu

Dokumentace je velmi důležitou součástí všech softwarových produktů. Když jsem zhruba před rokem a půl začal experimentovat s .NETem, byl jsem doslova zděšen dokumentací s příhodným názvem MSDN library (ano, je to skutečně obří knihovna). Předtím jsem totiž intenzivně používal jen oficiální manuál k PHP a to byla jedna radost – stačilo vyhledat název funkce, přečíst si stručný popis, shlédnout jeden nebo dva příklady a přečíst si zkušenosti uživatelů, které dost často řešily různé problematické situace. Navíc šlo všechno pěkně stáhnout v podobě CHM souborů.

Přechod na MSDN Library tedy byl docela šok. Obvykle bylo jednodušší najít odpověď v Googlu než kdesi v této obří dokumentaci. Rovněž jsem měl tehdy nemalé problémy s rozchozením MSDE, QuickStart Tutorials atd. atd.

Proto mě docela příjemně překvapilo, jak dobře mi oficiální dokumentace poradila v případě problémů kolem instalace verze 2005 beta 2. Po určitém experimentování mi přestaly chodit příklady z QuickStart Tutorials v2 a snaha o jejich opětovnou instalaci selhala. Dříve by asi byl značný problém znovu všechno rozchodit, ale dnes se na hlavní stránce příkladů nachází výrazný odkaz na stránku řešení případných problémů, kde jsem dostal jasné a přesné instrukce, které vedly k nápravě.

Samotná Library se také zlepšila, i když i zde jsou ještě nevychytané některé mouchy – např. jsem nenašel, jak nastavit, že chci vždy a všechny příklady pouze v C# a ne ve VB, JScriptu apod. Takhle musím po spuštění Library vždycky všechny filtry nastavit znovu, ale snad je to jen bug, který bude ostraněn.

Zdá se mi tedy, že dokumentace Microsoftu se lepší. Možná je ale také důvod jiný – už před rokem jsem zaznamenal, že když člověk dlouhodobě s dokumentací Microsoftu pracuje, učí se v ní chodit, pomalu zjišťuje, které postupy pravděpodobně povedou k řešení apod. Takže je taky možné, že se nezlepšila dokumentace, ale já :) .

Zařazeno do kategorií |

Komentáře jsou uzavřeny (blog je v read-only módu). Pokud mě chcete kontaktovat, můžete mailem.