Présentation de docs.microsoft.com

Cet article a été écrit par Jeff Sandquist, Directeur Général de la division Cloud + Enterprise.

aujourd’hui, nous vous proposons la version préliminaire de notre nouveau service de documentation https://docs.microsoft.com , en présentant le contenu qui prend en charge nos produits de mobilité Enterprise.

Pourquoi docs.microsoft.com ?

En bref, parce que le contenu est important. Nous avons interrogé des centaines de développeurs et professionnels de l’informatique. Nous avons aussi passé au peigne fin les commentaires que vous avez laissés au fil des années sur UserVoice au sujet de notre site web. La nécessité d’apporter des changements et de donner à notre contenu une expérience web moderne est clairement apparue. La première chose que nous avons faite a été d’évaluer notre infrastructure de contenu existante, à savoir TechNet et MSDN. Ces deux sites reposent sur un code base fragile. Ils ont été créés il y a 10 ou 15 ans au moyen d’un système de publication et de déploiement archaïque qui n’a pas été conçu pour le cloud.

Nous avons donc principalement porté notre attention sur l’expérience, sans toutefois négliger le contenu et la façon dont chacun d’entre vous le consomme. Pendant des années, nos clients nous ont demandé de dépasser le cadre du contenu sur les fonctionnalités et de les aider à implémenter des solutions aux problèmes qu’ils rencontrent dans leur entreprise. Nous savions donc que le contenu et la plateforme à mettre en place devaient permettre aux clients de découvrir et de déployer facilement des solutions.

Nous avons réalisé que pour obtenir une toute nouvelle expérience, il fallait tout recommencer à zéro. Le fruit de ces efforts : https://docs.microsoft.com, le nouveau visage de la documentation Microsoft.

remarque : cette version préliminaire du site web inclut le contenu * uniquement * pour Enterprise la Documentation mobilité (qui se compose d' Advanced Threat Analytics, Azure Active Directory, application distante Azure, Multi-factor authentication, Azure Rights Management, Intuneet Microsoft Identity Manager). Une fois que la plateforme aura atteint sa maturité, notamment grâce à vos commentaires, nous prévoyons d’y migrer davantage de contenu.

Principales fonctionnalités

Commençons par un exemple de page de documentation ci-dessous et nous présenterons quelques-unes des nouvelles fonctionnalités du site.

Documentation Example

Readability

Pour améliorer la lisibilité du contenu, nous avons modifié le site de manière à appliquer une largeur fixe au texte. Les études de suivi oculaire ont montré que vous pouvez améliorer la compréhension et la vitesse de lecture avec une largeur de contenu définie, car il est difficile pour l’œil de suivre de longs passages de gauche à droite. Pour le constater par vous-même, examinez l’exemple d’un article Intune dans docs.microsoft.com et dans TechNet. Nous avons également augmenté la taille de police pour le volet de navigation gauche et le texte lui-même, ce que les clients ont demandés (UserVoice-augmenter la taille de police).

Docs and TechNet comparison

Estimation du temps de lecture

Une autre amélioration simple que nous avons apportée en fonction de votre entrée consiste à fournir un temps de lecture estimé pour un article. Nous savons qu’un grand nombre d’entre vous sont en train d’apprendre/évaluer la technologie quelques minutes entre les réunions et vous êtes plus susceptible de lire des articles si vous saviez combien un engagement de temps est nécessaire. En réponse à d’autres commentaires laissés sur UserVoice, nous avons ajouté la date du contenu des articles pour que les clients sachent si les informations sont récentes.

Estimated reading time

Contenu et navigation du site

L’un des principaux domaines d’investissement en fonction des entretiens des clients et des Commentaires UserVoice était l’amélioration de la navigation sur le site, de l’architecture des informations et de l’organisation du contenu en fonction de l’intention du client. Nous avons ainsi restructuré notre contenu en plusieurs groupes logiques : l’évaluation, la prise en main, la planification, le déploiement, la gestion et le dépannage de produits ou de services. Ce contenu apparaît dans le volet de navigation gauche et dans les pages de nos produits et services.

Voici une capture d’écran de la page d’accueil de la documentation Intune :

Intune documentation screenshot

Les mêmes catégories se retrouvent dans le volet de navigation gauche des articles :

Left navigation

Raccourcissement de la longueur des articles

Un autre commentaire fréquent était que notre contenu peut parfois être surchargé en raison de sa longueur et que des articles longs sont plus difficiles à parcourir et à trouver ce que vous recherchez. Pour y remédier, nous avons divisé de nombreux articles longs en étapes logiques plus petites et fourni des boutons précédent et suivant en bas des articles pour naviguer entre les étapes d’un didacticiel en plusieurs parties, comme indiqué ci-dessous.

Back and Next buttons

Alors que de nombreux clients apprécient la possibilité d’avoir des didacticiels en plusieurs parties, certains clients nous ont fait savoir qu’ils souhaitent pouvoir combiner des didacticiels composés de plusieurs étapes en un seul et même fichier PDF imprimable en mode hors connexion. Nous n’offrons pas encore cette possibilité, mais cette option sera prochainement disponible dans la préversion.

Présentation interactive

Comme vous nous l’avez signalé sur UserVoice, l’expérience doit être conviviale sur appareil mobile, sur tablette et sur PC. Nous sommes donc passés à une présentation interactive. Quand vous cliquez sur le bouton Options, le contenu est développé ou réduit, laissant apparaître les mêmes options que sur un poste de travail.

Responsive Page Design

Contributions de la communauté

Toute la documentation proposée sur docs.microsoft.com est open source, ce qui signifie que la communauté peut y contribuer. Cette démarche va dans le sens de celle adoptée par d’autres équipes de Microsoft qui proposent déjà tout ou partie de leur documentation en open source, comme ASP.NET, Azure, .NET Core ou Microsoft Graph.

Chaque article est doté d’un bouton Modifier, comme illustré ci-dessous, qui vous permet d’accéder au fichier texte source dans GitHub. À partir de là, vous pouvez facilement envoyer une requête d’extraction pour corriger ou améliorer le contenu.

Mécanismes d’obtention des commentaires

Vos questions, avis et commentaires nous intéressent ! Nous avons conclu un partenariat avec Livefyre pour fournir des commentaires et des annotations sur tous nos articles. En haut de chaque article, vous verrez un lien pour les commentaires, comme indiqué ci-dessous.

Comments link

Quand vous cliquez sur Commentaires, vous accédez à la partie inférieure de la page. Ici, vous pouvez vous connecter à l’aide de vos informations d’identification Twitter, Facebook, Google, Yahoo ou Microsoft pour ajouter, suivre ou approuver des commentaires.

Comments at bottom

Vous pouvez également ajouter des annotations ou des remarques à un paragraphe spécifique ou à une partie de texte mise en surbrillance. Pour cela, positionnez le curseur de la souris sur le symbole des commentaires situé à droite du texte, puis cliquez dessus pour incorporer un commentaire à l’article.

Sidenote example

Partage sur les réseaux sociaux

Le bouton de partage situé en haut de la page vous permet de partager facilement du contenu sur Twitter et Facebook.

Sharing to Twitter and Facebook

Vous pouvez également sélectionner le contenu d’un article à l’aide de la souris, puis ajouter un commentaire ou le partager sur Twitter ou Facebook directement à partir du menu contextuel, comme illustré ci-dessous.

Select and comment or share content

URL conviviales

L’expérience web est importante pour nous. Et en tant qu’utilisateurs de TechNet et de MSDN, le fait que les articles ne disposaient pas d’URL conviviales et lisibles était une source fréquente de frustration. Voici un exemple du même article avec nos nouvelles URL.

  • Antérieures

  • Postérieur

Thèmes du site web

Pour répondre aux commentaires formulés par certains d’entre vous sur UserVoice, nous avons ajouté aux articles un sélecteur de thème qui vous permet désormais de choisir entre un thème clair et un thème sombre.

Light and Dark Theme Selector

L’image ci-dessous montre la différence entre le thème clair et le thème sombre.

Light and Dark themes

Fondamentaux

L’amélioration de certaines fonctionnalités de base, comme les performances du site, a fait l’objet de nombreuses demandes de la part des clients sur UserVoice. Le chargement des pages sur docs.microsoft.com est 50 à 300 % plus rapide, et nous sommes mieux géodistribués que par le passé. Nous avons également créé une architecture qui exécute 100% sur Azure.

Partagez votre expérience.

Nous espérons que la préversion de docs.microsoft.com vous donnera satisfaction. N’hésitez pas à envoyer vos commentaires à https://aka.ms/sitefeedback. Dans les prochaines publications, nous nous pencherons sur nos plans afin d’améliorer considérablement l’expérience du contenu de référence et nos plans de localisation de contenu.