Contribuer à la documentation Teams

  • Article

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

Configurer votre espace de travail

  • Installer dans VS Code :
  1. Sélectionnez l’icône Extensions dans la barre d’activités latérale ou utilisez la commande Affichage => Extensions ou Ctrl+Maj+X, puis recherchez Docs Authoring Pack.
  2. Sélectionnez Installer.
  3. Après l’installation, l'Installer passe au bouton d’engrenage Gérer .

Consultez le guide de Microsoft Docs contributeur

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

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 des informations de référence simples, ajoutez ce guide en ligne au menu favoris de votre navigateur.

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

  • écrire des 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.

Informations de référence sur MarkDown

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

Chemins d’accès

Lorsque vous utilisez des chemins d’accès relatifs et créez des liens vers d’autres documents, il est important de définir un chemin d’accès de 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, consultez utiliser des liens dans la documentation.

Importante

Pour référencer un article qui fait partie de la documentation de la plateforme Teams :
 ✔ Utilisez un chemin d’accès relatif sans barre oblique de début.
 ✔ Incluez l’extension de fichier Markdown.
Par exemple : répertoire parent/répertoire/chemin d’accès à article.md —>Création d’une application pour Microsoft Teams

Pour référencer un article Microsoft Learn qui ne fait pas partie du document de la plateforme Teams :
 ✔ Utilisez un chemin d’accès relatif qui commence par une barre oblique.
 ✔ N’incluez pas l’extension de fichier.
Par exemple : /docset/address-to-file-location —>Utiliser le API Graph Microsoft pour travailler avec Microsoft Teams

Pour référencer une page en dehors de Microsoft Learn, telle que GitHub, utilisez le chemin d’accès complet https 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 Kits de développement logiciel (SDK). Des exemples de code bien présentés peuvent communiquer plus clairement le fonctionnement des éléments que le texte descriptif et les informations d’instruction seuls. Vos exemples de code doivent être précis, concis, bien documentés et conviviaux. Le code facile à lire doit être facile à comprendre, tester, déboguer, gérer, modifier et étendre. Pour plus d’informations, consultez comment inclure du code dans un article.

Étape suivante

Résoudre les problèmes de votre application Microsoft Teams

Voir aussi