Mitwirken an der Teams-Dokumentation
Die Teams-Dokumentation ist Teil der Technischen Dokumentationsbibliothek von Microsoft Learn . Der Inhalt ist in Gruppen organisiert, die als Docsets bezeichnet werden und jeweils eine Gruppe verwandter Dokumente darstellen, die als einzelne Entität verwaltet werden. Artikel im selben Docset haben die gleiche URL-Pfaderweiterung nach learn.microsoft.com. Ist z. B /learn.microsoft.com/microsoftteams/... . der Anfang des Pfads der Teams-Docsetdatei. Teams-Artikel werden in der Markdownsyntax geschrieben und auf GitHub gehostet.
Einrichten Ihres Arbeitsbereichs
- Installieren Sie Git.
- Installieren Sie Microsoft Visual Studio Code (VS Code).
- Installieren Sie das Docs Authoring Pack direkt aus dem VS Code Marketplace.
oder
- Installation in VS Code:
- Wählen Sie auf der seitlichen Aktivitätsleiste das Symbol Erweiterungen aus, oder verwenden Sie den Befehl Ansicht => Erweiterungen oder STRG+UMSCHALT+X, und suchen Sie nach Docs Authoring Pack.
- Wählen Sie Installieren aus.
- Nach der Installation ändert sich die Schaltfläche Installieren an der Schaltfläche Zahnrad verwalten .
Lesen Sie den Leitfaden für Mitwirkende in der Microsoft-Dokumentation.
Der Leitfaden für Mitwirkende enthält Anweisungen zum Erstellen, Veröffentlichen und Aktualisieren von technischen Inhalten auf der Microsoft Learn-Plattform .
Microsoft-Schreib-, Stil- 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. Zur einfachen Referenz fügen Sie diesen Onlineleitfaden dem Favoritenmenü Ihres Browsers hinzu.
Schreiben von Entwicklerinhalten: Teams-spezifische Inhalte richten sich an eine Entwicklergruppe mit einem grundlegenden Verständnis von Programmierkonzepten und -prozessen. Es ist wichtig, dass Sie klare, technisch genaue Informationen auf überzeugende Weise bereitstellen und dabei den Ton und Stil von Microsoft beibehalten.
Schritt-für-Schritt-Anleitungen schreiben: Angewendete und interaktive Erfahrungen sind eine hervorragende Möglichkeit für Entwickler, sich über Microsoft-Produkte und -Technologien zu informieren. Die Darstellung komplexer oder einfacher Verfahren in einem progressiven Format ist natürlich und benutzerfreundlich.
MarkDown-Referenz
Microsoft Learn-Seiten werden in der MarkDown-Syntax geschrieben und über eine Markdig-Engine analysiert. Weitere Informationen zu bestimmten Tags und Formatierungskonventionen finden Sie unter Markdownreferenz zur Dokumentation.
Dateipfade
Wenn Sie relative Pfade verwenden und Links zu anderen Dokumenten erstellen, ist es wichtig, einen gültigen Dateipfad für Links in Ihrer Dokumentation festzulegen. Ihr Build ist auf GitHub nur erfolgreich, wenn der Dateipfad richtig oder gültig ist.
Weitere Informationen zu Links und Dateipfaden finden Sie unter Verwenden von Links in der Dokumentation.
Wichtig
So verweisen Sie auf einen Artikel, der Teil des Teams-Plattform-Docsets ist:
✔ Verwenden Sie einen relativen Pfad ohne führenden Schrägstrich.
✔ Schließen Sie die Markdown-Dateierweiterung ein.
Beispiel: übergeordnetes Verzeichnis/Verzeichnis/Pfad zu Artikel.md –>Erstellen einer App für Microsoft Teams
So verweisen Sie auf einen Microsoft Learn-Artikel, der nicht Teil der Dokumentation zur Teams-Plattform 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 für die Arbeit mit Microsoft Teams
Um auf eine Seite außerhalb von Microsoft Learn 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 deutlicher vermitteln, wie Dinge funktionieren als beschreibender Text und Anweisungsinformationen allein. Ihre Codebeispiele müssen genau, präzise, gut dokumentiert und leserfreundlich sein. Leicht lesbarer Code muss leicht zu verstehen, zu testen, zu debuggen, zu verwalten, zu ändern und zu erweitern sein. Weitere Informationen finden Sie unter Einschließen von Code in einen Artikel.