Si nxënës, të kesh dokumentacion të madh mund të bëjë ndryshimin. Disa nga këshillat më të mira që më janë dhënë ndonjëherë është t'i referohem gjithmonë dokumentacionit origjinal të çdo projekti përpara se të biesh në vrimën e lepurit të Google. Me këtë në mendje fillova të shikoj më nga afër dokumentacionin që përdor gjatë gjithë kohës. Nxrova faqet e Linux-it, gërmova në docker dhe u ktheva në GitHub për të parë disa projekte më të vogla. Disa shembuj ishin të mrekullueshëm si Udhëzuesit Ember.js, të tjerët dukeshin të dobët, por ishin të drejtpërdrejtë dhe të dobishëm si Golang. Megjithatë, të përbashkëtat me të gjitha dokumentet që shikova ishin të qarta. Dokumentacioni i shkëlqyer është i etiketuar mirë, përfshin një shirit kërkimi dhe kupton qëllimin e përdoruesit. Dokumentacioni më i mirë kishte gjithashtu shembuj, mësime dhe versione. Në një botë me përgjigje tepër agresive të Stackoverflow dhe me shumë përgjigje RTFM, dokumentacioni i menduar mirë, i dhembshur dhe i përditësuar mund të jetë një botë për këdo që përpiqet të fillojë.
Këtu është një listë e atyre që shikova:
developer.mozilla.org/en-US
stripe.com/docs
laravel.com/docs
golang.org/doc
guides.emberjs.com/release
docs.djangoproject.com/en/2.0
docs.oracle.com
Çështja ime nga kjo është se dokumentacioni i mahnitshëm i softuerit kërkon shumë kohë dhe përpjekje për t'u bërë siç duhet. Tani pyetja është - si e bën dikush më të lehtë këtë proces? Si mund ta ulim pengesën ndaj dokumentacionit të mahnitshëm të softuerit dhe ta bëjmë RTFM një këshillë pozitive?
