Démarrage rapide du style et de la voix de Microsoft Learn

  • Article

Ce démarrage rapide est un guide succinct pour rédiger du contenu technique destiné à la publication sur Microsoft Learn. Ces lignes directrices s’appliquent que vous créiez une nouvelle documentation ou en mettiez à jour une existante.

Meilleures pratiques :

  • Vérifier l’orthographe et la grammaire de vos articles, même si, pour ce faire, vous devez les copier/coller dans Microsoft Word.
  • Employer un ton informel et amical, comme si vous parliez à une autre personne face à face.
  • Utiliser des phrases simples. Des phrases simples à lire permettent au lecteur d’utiliser rapidement les conseils que vous partagez.

Utilisation des principes de ton de Microsoft

Nous aspirons à suivre ces principes lorsque nous écrivons du contenu technique pour Microsoft Learn. Nous n’y arrivons pas forcément toujours, mais nous devons nous efforcer d’essayer !

  • Concentrez-vous sur l'intention : Les clients ont un but précis à l’esprit lorsqu'ils consultent notre documentation. Avant de commencer à écrire, déterminez clairement qui est le client et la tâche qu'il ou elle essaye d'accomplir. Ensuite, écrivez votre article pour aider ce client spécifique à effectuer cette tâche spécifique.
  • Utilisez des mots de tous les jours : Essayez d’utiliser le langage naturel, les mots que vos clients utilisent. Soyez moins formel, mais pas moins technique. Fournissez des exemples pour expliquer les nouveaux concepts.
  • Écrivez de façon concise : Évitez les longs développements. Soyez affirmatif et n'utilisez pas de mots superflus ou de nombreux qualificateurs. Faites des phrases brèves et concises. Votre article doit rester centré. Si une tâche a un qualificateur, mettez-le au début de la phrase ou du paragraphe. Utilisez également un nombre minimal de notes. Une capture d’écran peut valoir une longue explication.
  • Rendez votre article facile à parcourir : Mettez les choses les plus importantes en premier. Utilisez des sections pour découper les longues procédures en groupes plus gérables d’étapes. (Les procédures comprenant plus de 12 étapes sont probablement trop longues.) Utilisez une capture d’écran si cela peut apporter de la clarté.
  • Montrez de l'empathie : Utilisez un ton rassurant dans l'article, et limitez les avertissements au minimum. Indiquez clairement les zones qui seront frustrantes pour les clients. Assurez-vous que l’article est centré sur ce qui compte pour les clients, ne donnez pas juste un discours technique.

Considérez la localisation et la traduction automatisée

Nos articles techniques sont traduits en plusieurs langues, et certains sont modifiés pour certains marchés ou certaines zones géographiques. Les utilisateurs peuvent également utiliser la traduction automatisée sur le web pour lire les articles techniques. Aussi, gardez les lignes directrices suivantes à l’esprit quand vous écrivez :

  • Assurez-vous que l'article ne contient pas d'erreurs de grammaire, d'orthographe ou de ponctuation : C'est quelque chose que nous devrions faire en tout temps. Certains éditeurs Markdown, comme Markdown Pad 2.0, offrent une vérification orthographique de base, mais il est conseillé de coller le contenu HTML rendu de l’article dans Word, qui offre un outil de vérification orthographique et grammaticale plus poussé.
  • Rendez vos phrases aussi courtes que possible : Les phrases composées ou chaînes de clauses compliquent la traduction. Divisez les phrases si vous pouvez le faire sans créer de redondance et en conservant un style naturel. Nous ne voulons pas non plus d’articles écrits avec un style affecté.
  • Utilisez des constructions de phrase simples et cohérentes : La cohérence facilite la traduction. Évitez les parenthèses et apartés, et placez le sujet aussi près du début de la phrase que possible. Consultez quelques articles publiés. Si un article a un style convivial et facile à lire, servez-vous-en comme modèle.
  • Utilisez des tournures et capitalisations cohérentes : Encore une fois, la cohérence est la clé. Ne mettez pas de majuscule à un mot si ce n’est pas un nom propre ou s’il n’est pas en début de phrase.
  • Incluez les « petits mots » : Les mots parfois considérés petits ou sans importance en anglais parce qu’ils sont compris dans leur contexte (les « a », « the », « that » et « is ») sont vitaux pour la traduction automatisée. N’oubliez pas de les inclure.

Autres questions liées au style et au ton à surveiller

  • N'interrompez pas les étapes avec des commentaires ou apartés.
  • Pour les étapes qui comprennent des extraits de code, mettez les informations supplémentaires au sujet de l'étape dans le code sous forme de commentaires. Cela réduit la quantité de texte que les utilisateurs doivent lire. Les informations essentielles sont copiées dans le projet de code pour leur rappeler ce que le code fait quand ils s’y rapportent plus tard.
  • Ne mettez que la première lettre en majuscule pour tous les titres.
  • Utilisez « se connecter » plutôt qu’« ouvrir une session ».
  • Pour obtenir plus d’instructions, consultez le Guide de style d’écriture Microsoft.

Documentation localisée

  • Si vous contribuez à la documentation localisée, référez-vous aux références de globalisation.
  • Pour obtenir des instructions relatives à la localisation, des informations sur le style et l’utilisation de la langue dans les publications techniques, ainsi que des renseignements sur les formats de données propres à chaque marché, téléchargez le guide de style dans votre langue.
  • Consultez la Terminologie Microsoft pour rechercher une terminologie approuvée spécifique au produit ou pour télécharger la Collection de Terminologie Microsoft dans votre langue.
  • Pour en savoir plus sur la localisation, consultez « Communications globales » dans le Guide de style d’écriture Microsoft.

Remarque

Le plus souvent, la documentation localisée ne permet pas d’apporter des modifications ni de formuler des commentaires par le biais de GitHub. Pour fournir des retours sur le contenu localisé, utilisez le formulaire https://aka.ms/provide-feedback.