Edit

Share via

Contribute to Teams documentation

  • Article

Teams documentation is part of the Microsoft Learn technical documentation library. The content is organized into groups called docsets, each representing a group of related documents managed as a single entity. Articles in the same docset have the same URL path extension after learn.microsoft.com. For example, /learn.microsoft.com/microsoftteams/... is the beginning of the Teams docset file path. Teams articles are written in Markdown syntax and hosted on GitHub.

Set up your workspace

  • Install within VS Code:
  1. Select the Extensions icon on the side activity bar or use the View => Extensions command or Ctrl+Shift+X and, search for Docs Authoring Pack.
  2. Select Install.
  3. After installation, the Install changes to the Manage gear button.

Review the Microsoft Docs contributor guide

The contributors guide provides direction to create, publish, and update technical content on the Microsoft Learn platform.

Microsoft Writing, Style, and Content Guides

  • Microsoft Writing Style Guide: Microsoft Writing Style Guide is a comprehensive resource for technical writing and reflects Microsoft's modern approach to voice and style. For easy reference, add this online guide to your browser's Favorites menu.

  • Writing developer content: Teams specific content is aimed at a developer audience with a fundamental understanding of programming concepts and processes. It's important that you must provide clear, technically accurate information in a compelling manner while maintaining Microsoft's tone and style.

  • Writing step-by-step instructions: Applied and interactive experiences are a great way for developers to learn about Microsoft products and technologies. Presenting complex or simple procedures in a progressive format is natural and user friendly.

MarkDown reference

Microsoft Learn pages are written in MarkDown syntax and parsed through a Markdig engine. For more information on specific tags and formatting conventions, see Docs Markdown reference.

File Paths

When using relative paths and creating links to other docsets, it's important to set a valid file path for hyperlinks in your documentation. Your build succeeds on GitHub only if the file path is correct or valid.

For more information on hyperlinks and file paths, see use links in documentation.

Important

To reference an article that is part of the Teams platform docset:
 ✔ Use a relative path without a leading forward slash.
 ✔ Include the Markdown file extension.
Ex: parent directory/directory/path-to-article.md —> Building an app for Microsoft Teams

To reference a Microsoft Learn article that is not part of the Teams platform docset:
 ✔ Use a relative path that begins with a forward slash.
 ✔ Do not include the file extension.
Ex: /docset/address-to-file-location —> Use the Microsoft Graph API to work with Microsoft Teams

To reference a page outside of Microsoft Learn, such as GitHub, use the full https file path.

Code Samples and Snippets

Code samples play an important role to use APIs and SDKs effectively. Well presented code samples can communicate how things work more clearly than descriptive text and instructional information alone. Your code samples must be accurate, concise, well documented, and reader friendly. Code that is easy to read must be easy to understand, test, debug, maintain, modify, and extend. For more information, see how to include code in an article.

Next step

Troubleshoot your Microsoft Teams app

See also