Online kurz Jazyk Markdown a Tvorba Dokumentácie vám pomôže vytvárať zrozumiteľné návody, projektové prehľady a technické texty, ktoré sa dajú jednoducho upravovať a zdieľať. Ide o certifikovaný online kurz zameraný na Markdown a dokumentáciu projektov na GitHube. Začneme princípmi značkovacieho jazyka a ukážeme si, ako pomocou jednoduchých znakov určujeme štruktúru a formátovanie textu. Vytvoríme README dokumentáciu, ktorá čitateľovi vysvetlí účel projektu, základné používanie a miesto, kde nájde ďalšie informácie. Naučíme sa rozčleniť obsah tak, aby sa v ňom zorientoval nový používateľ aj kolega v tíme. Predchádzajúce skúsenosti s programovaním nepotrebujeme; sústredíme sa na obsah, jeho usporiadanie a praktickú prácu s dokumentmi.
Pri písaní si osvojíme nadpisy, zoznamy, zvýraznenie textu, odkazy a obrázky. Zoznámime sa aj s používaním emoji a tabuliek pri dokumentovaní projektov na GitHube. Budeme prepájať súvisiace informácie a pripravovať prehľadné sekcie, v ktorých čitateľ ľahko nájde potrebný postup alebo vysvetlenie. Pri rozšírených možnostiach formátovania zohľadníme prostredie, v ktorom sa dokument zobrazuje. Následne prejdeme od jedného súboru k rozsiahlejšej dokumentácii. Vysvetlíme si využitie GitHub Wiki na samostatné tematické stránky a GitHub Pages na publikovanie dokumentácie vo forme webu. Rozlíšime úvodný README súbor, projektovú wiki a publikovanú stránku, aby sme pre konkrétny obsah vedeli zvoliť vhodné miesto a spôsob sprístupnenia.
V ďalšej časti prepojíme dokumentáciu s organizáciou práce na GitHube. Pomocou GitHub Issues sa budeme venovať evidencii problémov, požiadaviek a úloh, ktoré môžu zahŕňať aj opravy alebo doplnenia dokumentácie. Spoznáme sekciu Insights a jej využitie pri sledovaní aktivity projektu. Oboznámime sa so šablónami, ktoré uľahčujú opakované vytváranie podobného obsahu, aj s princípom Git LFS pri správe väčších súborov. Získané postupy využijeme pri dokumentovaní softvéru, interných pracovných postupov, školských projektov alebo otvorených repozitárov. Dokážeme tak pripraviť dokumentáciu, ktorá má jasnú štruktúru a dá sa priebežne udržiavať spolu s projektom. Ak sa chcete skutočne naučiť písať v Markdowne a organizovať aj publikovať dokumentáciu na GitHube, tak toto je ideálny vstupný online kurz pre vás.