Einführung in Azure DevOps-Projekt-Wikis

Abgeschlossen

Azure DevOps Projects enthält eine Option zum Erstellen eines Projekt-Wikis.

Projekt-Wiki

Das Wiki dient dazu, Informationen mit Ihrem Team zu teilen, um Ihr Projekt zu verstehen und zu unterstützen.

Wikis werden in einem Repository gespeichert. Es wird kein Wiki automatisch bereitgestellt.

Voraussetzungen

Sie müssen über die Berechtigung zum Erstellen eines Repositorys verfügen, um Code als Wiki zu veröffentlichen. Die Gruppe Projektadministratoren verfügt standardmäßig über diese Berechtigung, sie kann jedoch auch anderen Personen zugewiesen werden.

Um Wikiseiten hinzuzufügen oder zu bearbeiten, müssen Sie Mitglied der Gruppe Mitwirkende sein.

Alle Mitglieder des Teamprojekts (einschließlich der Projektbeteiligten) können das Wiki anzeigen.

Erstellung

Der folgende Artikel enthält Details zum Erstellen eines Wiki: Erstellen eines Wikis für Ihr Projekt.

Bearbeiten des Wikis

Der folgende Artikel enthält Details zum Veröffentlichen eines Git-Repositorys in einem Wiki: Veröffentlichen eines Git-Repositorys in einem Wiki.

Markdown

Azure DevOps Wikis sind in Markdown geschrieben und können auch Dateianlagen und Videos enthalten.

Markdown ist eine Markupsprache. Der Nur-Text enthält Formatierungssyntax. Es ist jetzt zum Defacto-Standard für die Erstellung von Projekt- und Softwaredokumentation geworden.

Ein wichtiger Grund dafür ist, dass es, da es aus Nur-Text besteht, viel leichter zusammengeführt werden kann, als dies bei Programmcode der Fall ist.

Es ermöglicht die Verwaltung von Dokumenten mit denselben Tools, die auch zum Erstellen von anderem Code in einem Projekt verwendet werden.

GitHub Flavored Markdown (GFM)

GFM ist eine formale Spezifikation, die von GitHub veröffentlicht wurde und Erweiterungen zu einem Basisformat namens CommonMark hinzugefügt hat. GFM ist sowohl innerhalb von GitHub als auch extern weit verbreitet. GFM wird in Azure DevOps Wikis gerendert.

Mermaid

Mermaid ist zu einer unverzichtbaren Erweiterung von Markdown geworden, da es die Aufnahme von Diagrammen in die Dokumentation ermöglicht.

Es überwindet die bisherigen Schwierigkeiten beim Zusammenführen von Dokumentationen, die Diagramme in Form von Binärdateien enthalten.

Mermaid-Markup

Mermaid-Rendering

Details zur Mermaid-Syntax finden Sie hier: Mermaid Introduction