Microsoft travaille actuellement sur une révision en profondeur de son site dédié à ses diverses documentations pour les développeurs et professionnels. L’éditeur n’hésite pas à décrire l’actuel comme « archaïque ».
Microsoft dispose depuis bien longtemps d’une vaste documentation pour ceux qui ont besoin de manipuler ses technologies. La bibliothèque la plus connue est sans conteste MSDN (Microsoft Developer Network) qui regroupe des renseignements et exemples sur l’ensemble des produits, langages, API et autres proposés aux développeurs. L’autre, que connaissent bien les professionnels, est TechNet.
Des sites poussiéreux
Considérant le nombre très élevé de solutions disponibles chez le géant, il n’est pas surprenant que cette volumineuse documentation soit devenue vaste au point de créer des problèmes d’accessibilité, qu’il s’agisse de MSDN ou de TechNet. Et pour cause : « Les deux sites ont été bâtis sur une base de code fragile datant d’il y a 10-15 ans avec un système archaïque de publication et de déploiement qui n’a jamais été prévu pour fonctionner dans le cloud ».
Microsoft indique donc avoir demandé l’avis de centaines de développeurs et professionnels, tout en suivant les suggestions sur le site UserVoice. Globalement, il était demandé à la firme d’aller au-delà des « murs de textes » en fournissant à ceux qui en avaient besoin des solutions et des mesures proactives, afin que l’ensemble soit beaucoup moins statique.
Lisibilité et responsive design
Le site docs.microsoft.com fait son apparition, en préversion pour le moment. Premier changement, la lisibilité des articles, dont les lignes sont beaucoup plus courtes (une taille maximale a été fixée) et la police plus grande. Deux demandes apparemment régulières des utilisateurs. Chaque article dispose en outre d’une date de publication et d’un temps estimé de lecture.
La réorganisation du contenu est également un élément clé. Chaque grande section correspondant à un produit ou une technologie est accompagnée désormais de plusieurs points mis en avant et classés par thématiques : découvrir, planification, déploiement, gestion, problèmes, services, etc. Une classification qui se retrouve propulsée aussi dans la barre latérale gauche, qui reprend l’index de la documentation globale sur le sujet.
Outre un ensemble passé à la moulinette du responsive design (adaptation automatique à la taille de l’écran, surtout sur les appareils mobiles), Microsoft profite de l’occasion pour revoir la documentation elle-même. L’éditeur s’est en particulier attaqué aux très longs articles techniques, qui pouvaient se montrer décourageant par leur volume. De nombreux textes ont donc été divisés en sections logiques, accompagnés d’éléments de navigation pour se déplacer dans les chapitres. Microsoft ajoutera par la suite une fonction permettant de réunir l’ensemble des chapitres au sein d’un document PDF récupérable.
Une documentation open source
La nouvelle documentation se veut également beaucoup plus axée sur la communauté. Elle passe donc en open source, comme celles d’ASP.NET, Azure, .NET Core et Graph. Chaque article est accompagné d’un bouton de modification qui permet d’accéder aux sources du fichier Markdown correspondant sur GitHub. Toute modification crée une pull request qui sera inspectée par la suite.
Les pages d’articles seront également munies d’un bouton permettant de les commenter. Pour cette fonction, Microsoft s’est associée à… Livefyre, tout juste racheté par Adobe. Il faudra se connecter pour laisser un commentaire, mais la société laisse le choix des armes : Twitter, Facebook, Google, Yahoo, ou le compte Microsoft évidemment. Le partage est lui aussi simplifié, soit pour un article entier (via un bouton dédié), soit à partir d’une simple sélection de texte. Enfin, Docs peut être utilisé sous deux thèmes, clair et sombre.
