Contribuer à la documentation Teams

Teams documentation technique fait partie de la bibliothèque de documentation technique Microsoft Docs. Le contenu est organisé en groupes appelés ensembles de documents, chacun représentant un groupe de documents associés gérés en tant qu’entité unique. Les articles du même ensemble de documents ont la même extension de chemin d’URL docs.microsoft.com. Par exemple, /docs.microsoft.com/microsoftteams/... est le début du chemin d Teams fichier docset. Teams articles sont écrits en syntaxe Markdown et hébergés sur GitHub.

Configurer votre espace de travail

  • Installez dans VS Code :
  1. Sélectionnez l’icône Extensions dans la barre d’activité latérale ou utilisez la commande Afficher => Extensions ou Ctrl+Shift+X et, recherchez Microsoft Docs Authoring Pack.
  2. Sélectionnez Installer.
  3. Après l’installation, l’installation est apportée au bouton Gérer l’engrenage.

Consulter le Guide des contributeurs Microsoft Docs

Le guide des collaborateurs fournit des instructions pour créer, publier et mettre à jour du contenu technique sur la plateforme Microsoft Docs.

Guides d’écriture, de style et de contenu Microsoft

  • Guide de style d’écriture Microsoft: le Guide de style d’écriture Microsoft est une ressource complète pour l’écriture technique et reflète l’approche moderne de Microsoft en matière de voix et de style. Pour faciliter la référence, ajoutez ce guide en ligne au menu Favoris de votre navigateur.

  • Écriture de contenu développeur: Teams contenu spécifique est destiné à un public de développeurs ayant une compréhension fondamentale des concepts et processus de programmation. Il est important que vous fournissiez des informations claires et techniques précises de manière attrayante tout en conservant le style et le ton de Microsoft.

  • Écriture d’instructions pas à pas: les expériences appliquées et interactives sont un excellent moyen pour les développeurs d’en savoir plus sur les produits et technologies Microsoft. La présentation de procédures complexes ou simples dans un format progressif est naturelle et conviviale.

Référence MarkDown

Les pages Microsoft Docs sont écrites dans la syntaxe MarkDown et sont par le biais d’un moteur Markdig. Pour plus d’informations sur des balises et des conventions de mise en forme spécifiques, voir référence Docs Markdown.

Chemins d’accès aux fichiers

Lorsque vous utilisez des chemins d’accès relatifs et que vous créez des liens vers d’autres ensembles de documents, il est important de définir un chemin d’accès au fichier valide pour les liens hypertexte dans votre documentation. Votre build réussit sur GitHub uniquement si le chemin d’accès au fichier est correct ou valide.

Pour plus d’informations sur les liens hypertexte et les chemins d’accès aux fichiers, voir les liens d’utilisation dans la documentation.

Important

Pour référencer un article qui fait partie du document Teams plateforme de données :
 ✔ utiliser un chemin d’accès relatif sans barre oblique principale.
 ✔ inclure l’extension de fichier Markdown.
Ex: parent directory/directory/path-to-article.md —> Building an app for Microsoft Teams

Pour référencer un article de la bibliothèque Microsoft Docs qui ne fait pas partie du document Teams plateforme microsoft :
 ✔ utilisez un chemin d’accès relatif qui commence par une barre oblique.
 ✔ n’incluez pas l’extension de fichier.
Ex : /docset/address-to-file-location —> l’API Microsoft Graph pour travailler avec Microsoft Teams

Pour référencer une page en dehors de la bibliothèque Microsoft Docs, telle que GitHub, utilisez le chemin https d’accès complet du fichier.

Exemples de code et extraits de code

Les exemples de code jouent un rôle important pour utiliser efficacement les API et les SDK. Des exemples de code bien présentés peuvent communiquer plus clairement que le texte descriptif et les informations d’instruction uniquement. Vos exemples de code doivent être précis, concis, bien documentés et concis et concis. Le code facile à lire doit être facile à comprendre, tester, déboguer, gérer, modifier et étendre. Pour plus d’informations, voir comment inclure du code dans des documents.

Étape suivante

Voir aussi