Mitwirken an der Teams-Dokumentation

Teams Dokumentation ist Teil der technischen Dokumentationsbibliothek von Microsoft Docs. Der Inhalt ist in Gruppen unterteilt, die als Docsets bezeichnet werden und jeweils eine Gruppe verwandter Dokumente darstellen, die als einzelne Entität verwaltet werden. Artikel im selben Dokumentsatz weisen nach docs.microsoft.com die gleiche URL-Pfaderweiterung auf. Ist beispielsweise /docs.microsoft.com/microsoftteams/... der Anfang des Teams Docset-Dateipfads. Teams Artikel werden in markdown-Syntax geschrieben und auf GitHub gehostet.

Einrichten des Arbeitsbereichs

  • Installieren in VS Code:
  1. Wählen Sie das Erweiterungssymbol auf der Seitenaktivitätsleiste aus, oder verwenden Sie den Befehl Ansicht => Erweiterungen oder STRG+UMSCHALT+X, und suchen Sie nach Microsoft Docs Authoring Pack.
  2. Wählen Sie Installieren aus.
  3. Nach der Installation wird die Schaltfläche "Install" auf die Schaltfläche "Zahnrad verwalten" geändert.

Überprüfen des Leitfadens für Mitwirkende zu Microsoft-Dokumenten

Der Leitfaden für Mitwirkende gibt die Richtung zum Erstellen, Veröffentlichen und Aktualisieren von technischen Inhalten auf der Microsoft Docs-Plattform an.

Microsoft Writing-, Style- und Inhaltshandbücher

  • Microsoft Writing Style Guide: Microsoft Writing Style Guide ist eine umfassende Ressource für technisches Schreiben und spiegelt den modernen Ansatz von Microsoft für Sprache und Stil wider. Fügen Sie dieses Onlinehandbuch zum Favoritenmenü Ihres Browsers hinzu, um eine einfache Referenz zu finden.

  • Schreiben von Entwicklerinhalten: Teams bestimmten Inhalten richtet sich an eine Entwicklergruppe mit grundlegendem Verständnis von Programmierkonzepten und -prozessen. Es ist wichtig, dass Sie klare, technisch genaue Informationen auf überzeugende Weise bereitstellen und gleichzeitig den Ton und Stil von Microsoft beibehalten.

  • Schrittweise Anleitungen schreiben: Angewendete und interaktive Benutzeroberflächen sind eine großartige Möglichkeit für Entwickler, sich über Microsoft-Produkte und -Technologien zu informieren. Das Darstellen komplexer oder einfacher Prozeduren in einem progressiven Format ist natürlich und benutzerfreundlicher.

MarkDown-Referenz

Microsoft Docs-Seiten werden in MarkDown-Syntax geschrieben und über ein Markdig-Modul analysiert. Weitere Informationen zu bestimmten Tags und Formatierungskonventionen finden Sie unter Docs Markdown Reference.

Dateipfade

Wenn Sie relative Pfade verwenden und Links zu anderen Dokumentenmappen erstellen, ist es wichtig, einen gültigen Dateipfad für Hyperlinks in Ihrer Dokumentation festzulegen. Ihr Build ist auf GitHub nur erfolgreich, wenn der Dateipfad korrekt oder gültig ist.

Weitere Informationen zu Hyperlinks und Dateipfaden finden Sie unter Verwenden von Links in der Dokumentation.

Wichtig

So verweisen Sie auf einen Artikel, der Teil des Teams-Plattformdokuments ist:
 ✔ Verwenden Sie einen relativen Pfad ohne vorangestellten Schrägstrich.
 ✔ schließen Sie die Dateierweiterung Markdown ein.
Beispiel: übergeordnetes Verzeichnis/Verzeichnis/Pfad-zu-article.md – > Erstellen einer App für Microsoft Teams

So verweisen Sie auf einen Microsoft Docs-Bibliotheksartikel, der nicht Teil des Teams Plattform-Docset ist:
 ✔ Verwenden Sie einen relativen Pfad, der mit einem Schrägstrich beginnt.
 ✔ Schließen Sie die Dateierweiterung nicht ein.
Beispiel: /docset/address-to-file-location - > Verwenden der Microsoft Graph-API zum Arbeiten mit Microsoft Teams

Um auf eine Seite außerhalb der Microsoft Docs-Bibliothek zu verweisen, z. B. GitHub, verwenden Sie den vollständigen https Dateipfad.

Codebeispiele und Codeausschnitte

Codebeispiele spielen eine wichtige Rolle bei der effektiven Verwendung von APIs und SDKs. Gut dargestellte Codebeispiele können deutlich vermitteln, wie alles funktioniert, als beschreibende Text- und Anleitungsinformationen allein. Ihre Codebeispiele müssen präzise, präzise, gut dokumentiert und leserfreundlicher sein. Code, der leicht zu lesen ist, muss leicht verständlich sein, testen, debuggen, verwalten, ändern und erweitern. Weitere Informationen finden Sie unter "Einfügen von Code in Dokumente".

Nächster Schritt

Siehe auch