Freigeben über

Über Wikis, READMEs und Markdown

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

Sie können Ihre Team- und Projektmitwirkenden unterstützen, indem Sie Markdown verwenden, um Ihrem Teamprojekt umfangreiche Formatierungen, Tabellen und Bilder hinzuzufügen. Das Markdown-Format verbessert Teamprojekt-Wiki-Seiten, Inhalte, die Sie einem Dashboard, ihrer Teamprojekt-README-Datei oder anderen Repository-README-Dateien hinzufügen.

Einrichten eines Projektwikis

Mit einem Teamprojektwiki können Sie Informationen zu Ihrem Projekt mit anderen Teammitgliedern teilen. Wenn Sie ein Wiki von Grund auf neu einrichten, speichert ein neues Git-Repository Ihre Markdown-Dateien, -Bilder, -Anlagen und -Abfolge von Seiten. Das Wiki unterstützt die gemeinsame Bearbeitung von Inhalten und Strukturen.

Die folgenden Links beschreiben die unterstützten Features für ein Teamprojektwiki.

Neues Wiki erstellen

Arbeiten mit Wiki-Inhalten

Formatieren von Wiki-Inhalten

Veröffentlichen von Git-Repositorys in einem Wiki

Viele Teams dokumentieren ihren Code mithilfe von Markdown-Dateien, die sie zusammen mit ihrem Code in das Repository einchecken. Während Git die Wartung und Überprüfung von Codedokumentationsdateien mithilfe des standardmäßigen Pullanforderungsprozesses unterstützt, können diese Dateien den Verbrauchern des Inhalts Herausforderungen stellen.

  • Der Benutzer muss häufig viele Dateien und Ordner durchsuchen, um den inhalt des Interesses zu finden.
  • Inhalt fehlt an Organisation und Struktur. Es gibt keine inhärente Seitenhierarchie, um Leser zu unterstützen.
  • Die Inhaltsversionsverwaltung wird nicht unterstützt.
  • Das Durchsuchen von Inhalten basiert auf der Suche nach dem Code und nicht auf einer suchumgebung, die für die Suche von Inhalten optimiert ist.

Mit dem Feature " Code veröffentlichen als Wiki " können Sie ein oder mehrere Git-Repositorys veröffentlichen, die in Ihrem Teamprojekt in einem Wiki definiert sind. Dieses Feature bietet eine Möglichkeit, ihre Codedokumentation synchron mit Ihrer Codebasis zu verwalten und sie selektiv in einem Wiki zu veröffentlichen und zu aktualisieren.

Es gibt erhebliche Unterschiede zwischen der Verwaltung der Inhalte in einem Wiki für ein Teamprojekt im Vergleich zu Wiki-Seiten, die Sie aus einem Git-Repository veröffentlichen. Ausführliche Informationen finden Sie unter Veröffentlichen eines Git-Repositorys in einem Wiki.

Verbessern von Projektinhalten mit Markdown

Das Markdown-Format erleichtert das Formatieren von Text und das Einschließen von Bildern. Sie können auch Links zu Dokumenten auf Ihren Projektseiten, README-Dateien, Dashboards und Pullanforderungen erstellen.

Sie können Markdown verwenden, um Ihrem Team auf folgende Weise Anleitungen bereitzustellen:

Unterstützte Syntax finden Sie unter Verwenden von Markdown in Azure DevOps.

Hinzufügen von PROJEKT-README-Dateien

Sie können eine README-Datei oder mehrere Dateien für jedes Repository- oder Teamprojekt definieren. Schreiben Sie Ihre README in Markdown anstelle von Nur-Text. Verwenden Sie README-Seiten, um Mitwirkende an bestimmten Informationen oder Orten in Ihrem Projekt auszurichten.

Erwägen Sie das Hinzufügen der folgenden Anleitungen:

  • Projektfokus
  • Voraussetzungen
  • Einrichten der Umgebung
  • Tipps zum Erledigen von Aufgaben innerhalb des Projekts
  • Zweck oder Verwendung bestimmter Dateien
  • Projektspezifische Begriffe und Akronyme
  • Workflowanleitung zum Commit oder Hochladen von Änderungen und Hinzufügen von Verzweigungen
  • Projektsponsoren oder Kontakte

README-Beispiele

Hier sind einige Beispiele für Projekt READMEs in GitHub, die alle Zielgruppen für Referenz und Inspiration unterstützen: