Informace o wikiwebech, souborech READM a Markdownu

  • Článek

Azure DevOps Services | Azure DevOps Server 2022 – Azure DevOps Server 2019

Pokud chcete podporovat svůj tým nebo přispěvatele projektu, použijte Markdown k přidání bohatého formátování, tabulek a obrázků do týmového projektu. Formát Markdownu můžete použít na wikiwebu týmového projektu, obsah, který přidáte na řídicí panel, soubor README vašeho týmového projektu nebo jiný soubor README úložiště.

Wiki

Prostřednictvím wikiwebu týmového projektu můžete sdílet informace s ostatními členy týmu. Při vytváření wikiwebu od nuly se do nového úložiště Git ukládají soubory Markdown, obrázky, přílohy a posloupnost stránek. Tento wikiweb podporuje úpravy obsahu a struktury v rámci spolupráce.

Publikování existujících úložišť Git na wikiweb

Mnoho týmů dokumentuje kód pomocí Markdownu a tyto soubory se změnami spolu s kódem. Git sice podporuje údržbu a kontrolu takové dokumentace spolu se standardními žádostmi o přijetí změn, ale tyto soubory představují pro uživatele obsahu několik výzev.

  • Čtenáři musí často procházet mnoho souborů a složek, aby našli obsah zájmu.
  • Obsah nemá organizaci a strukturu. Neexistuje žádná inherentní hierarchie stránek, která by podporovala čtenáře.
  • Správa verzí obsahu se nepodporuje.
  • Vyhledávání prostřednictvím obsahu se spoléhá na vyhledávání kódů místo vyhledávání optimalizovaného pro vyhledávání obsahu.

Pomocí kódu pro publikování jako funkce wikiwebu můžete publikovat jedno nebo více úložišť Git definovaných v týmovém projektu na wikiweb. Tato funkce poskytuje způsob, jak udržovat obsah vedle základu kódu a umožňuje selektivně publikovat a aktualizovat obsah na wikiwebu.

Mezi správou obsahu wikiwebu, který zřizujete pro týmový projekt, a stránkami wikiwebu, které publikujete z úložiště Git, existují značné rozdíly. Podrobnosti najdete v tématu Publikování úložiště Git na wikiwebu.

Markdown

Markdown usnadňuje formátování textu a zahrnutí obrázků. Můžete také propojit dokumenty na stránkách projektu, souborech README, řídicích panelech a žádostech o přijetí změn. Pokyny pro svůj tým můžete poskytnout na následujících místech pomocí Markdownu:

Podporovanou syntaxi najdete v tématu Použití Markdownu v Azure DevOps.

Soubory README

Můžete definovat soubor README nebo více souborů pro každé úložiště nebo týmový projekt. Místo prostého textu napište soubor README v Markdownu.

Stránky README slouží k orientaci přispěvatelů při práci v rámci projektu. Zvažte přidání následujících pokynů:

  • Projektový fokus
  • Požadavky
  • Nastavení prostředí
  • Tipy pro práci v rámci projektu
  • Účel nebo použití konkrétních souborů
  • Termíny a zkratky specifické pro projekt
  • Pokyny k pracovnímu postupu při potvrzení nebo nahrání změn a přidávání větví
  • Sponzory projektů nebo kontakty

Tady je několik skvělých readmes, které používají tento formát a hovoří se všemi cílovými skupinami pro referenci a inspiraci: