Une api pour tous
TL;DR:
- Nous avons reçu de nombreuses plaintes de clients utilisant notre API et avons remarqué que la documentation était rédigée par nos développeurs.
- J'ai décidé d'interviewer chaque type d'utilisateurs pour comprendre leur processus (développeurs, utilisateurs de WordPress, équipe de vente interne).
- J'ai appris à utiliser Postman et j'ai rédigé une documentation adaptée aux développeurs.
- J'ai également rédigé une documentation sur mesure pour les utilisateurs de CMS (WordPress, Shopify, Prestashop).
- Création d'une présentation pour nos équipes internes afin de les aider à mieux dialoguer avec nos utilisateurs.
- L'équipe : Moi-même, 1 Product Manager, 1 Product Owner, 1 Junior UX Designer
INTRODUcTION
Lorsque les termes "recherche UX", "expérience utilisateur" ou "conception d'interface utilisateur" sont mentionnés, vous pouvez immédiatement les associer à des sites web, des outils pour utilisateurs, des interfaces logicielles, des interactions intuitives et des graphiques attrayants. Bien que ces associations soient toutes valables, vous avez peut-être négligé l'un de nos utilisateurs les plus importants - les développeurs !
"Une API qui n'est pas compréhensible n'est pas utilisable." James Gosling, fondateur de Java
Contexte
Fondé en 2016, Paps est un service destiné aux entreprises opérant en Afrique francophone, offrant des services d'entreposage, de ramassage et de livraison. Ils sont la première entreprise de livraison à la demande et géolocalisée dans la région avec la plus grande flotte en Afrique de l'Ouest. Elle s'est fait connaître en remportant la cinquième édition de Hub Africa et a attiré des investissements de Google et d'Alibaba's Global Initiatives. Elle propose ses services à un large éventail d'industries, notamment les institutions financières, les produits pharmaceutiques, les télécommunications, les détaillants et, surtout, les e-commerçants, qui peuvent intégrer l'API de Paps dans leur système pour envoyer leurs produits.
Le segment des e-commerçants a connu une croissance importante et l'équipe produit s'est rapidement trouvée submergée par des demandes d'aide à l'intégration, provenant à la fois des clients directement et des commerciaux.
En tant que UX designer, j’ai été confronté au défi de rendre l’intégration de l’API plus conviviale pour les utilisateurs, alors que la documentation était complexe, les termes métiers peu explicites et que les utilisateurs de CMS manquaient de support adéquat pour intégrer l’API à leur plateforme.
Understanding and framing the problem
Créer une API que seuls les développeurs qui l’ont développé peuvent comprendre est inutile, car les vrais bénéficiaires sont les personnes qui utilisent et interagissent avec l’API. Le premier défi était de comprendre les exigences et les défis des utilisateurs de l’API. La meilleure approche pour comprendre leurs problèmes et fournir des solutions à leurs questions est de mener des recherches.
Mais avant de faire la recherche il fallait que je comprenne comment marche l’API, savoir utiliser des outils pour tester les requêtes, savoir envoyer des requêtes Json, savoir lire les erreurs etc. En gros, se documenter et intégrer le monde des développeurs.
Un designer au sein d’une équipe de développeurs ? Travaillant sur la documentation ? On pourrait dire que c’est comme mélanger de l’eau et de l’huile, mais c’est tout le contraire. J’ai moi-même parcouru ma part de documentation, de posts Stack Overflow et de blogs au fil des mois.
Postman
Postman est un outil de développement d’API qui permet de tester, déboguer et documenter les API. Il permet également de créer des collections de requêtes pour les utiliser ultérieurement.
J’ai pu prendre en main Postman assez facilement car j’ai déjà étudié le développement de logiciels avant de me tourner vers le UX Design. J’ai pu comprendre rapidement comment fonctionne l’outil et à l’utiliser efficacement pour tester les requêtes, envoyer des requêtes Json et lire les erreurs.
LA RECHERCHE
Les clients
La recherche sur les utilisateurs que j'ai menée pour comprendre les défis de l'intégration de l'API s'est déroulée en plusieurs étapes. Tout d'abord, j'ai identifié un échantillon représentatif de clients et de prospects qui avaient déjà utilisé l'API ou qui envisageaient de l'utiliser avec l'aide de notre équipe de vente et d'assistance. Je les ai ensuite contactés et les ai invités à participer à des entretiens téléphoniques individuels. Certains l'ont fait en compagnie de leurs développeurs.
Au cours de ces entretiens, j’ai posé des questions ouvertes pour comprendre les difficultés qu’ils avaient rencontrées lors de l’intégration de l’API. Certaines plaintes sont souvent revenues, notamment la complexité de la documentation, le manque de clarté des termes métiers, et l’absence de documentation spécifique pour les utilisateurs de CMS comme WordPress, Shopify, PrestaShop et Magento.
J’en ai profité pour explorer leurs habitudes d’utilisation, leurs attentes et leurs besoins. Les participants ont exprimé leur désir d’avoir une documentation claire et accessible, des exemples d’utilisation de l’API, et un support technique réactif et disponible en cas de besoin.
Les développeurs interne
Après avoir mené des entretiens avec les développeurs internes, j’ai découvert que la documentation de l’API était souvent envoyée aux clients sous la forme d’un lien vers Swagger UI, un outil en ligne permettant de tester les endpoints de l’API. Bien que cet outil puisse être utile pour les développeurs, il n’offrait pas de véritable documentation structurée et complète pour les utilisateurs non-techniques.
En conséquence, les clients qui utilisaient l’API pour la première fois rencontraient souvent des difficultés pour comprendre comment fonctionnaient les différentes fonctionnalités et les endpoints de l’API. Ils étaient confrontés à une documentation complexe et peu claire qui ne leur permettait pas de se concentrer sur leur objectif principal : intégrer l’API à leur projet en toute simplicité.
Les commerciaux et le service client
Lors de mes recherches, j’ai constaté que les commerciaux et le service client ne comprenaient pas toujours les subtilités de l’API que Paps proposait. Ils n’étaient pas en mesure de répondre aux questions des clients sur les fonctionnalités de l’API, ou de fournir des conseils sur l’intégration et le dépannage. En conséquence, chaque fois qu’un client avait une question ou un problème avec l’API, il était immédiatement redirigé vers l’équipe de développement, sans veritable informations précise de base.
Cela créait une surcharge de travail pour les développeurs, qui étaient souvent obligés de consacrer du temps et de l’énergie à résoudre des problèmes mineurs ou à répondre à des questions triviales. En fin de compte, cela affectait la productivité et la satisfaction des clients, qui avaient l’impression de ne pas recevoir le niveau de soutien dont ils avaient besoin.
how might we...
Pour orienter ma conception, j’ai formulé plusieurs HMW, dont « Comment pouvons-nous rendre l’utilisation de l’API plus simple et plus intuitive pour les profanes ? », « Comment pouvons-nous réduire le temps de formation pour les utilisateurs de CMS qui n’ont pas de formation technique ? » et « comment pourrions nous mettre en place un circuit fluide avec les Sales pour guider les prospects dans l’intégration de l’API». J’ai utilisé ces questions pour guider ma recherche de solutions.
solutions
Pour les développeurs
Après un long benchmark pour trouver l’outil parfait, jai découvert que Postman générait automatiquement une documentation de base pour toute collection créée. Je m’en suis servi pour mettre en place une documentation complète et détaillée. Cette documentation a été conçue pour permettre aux clients de comprendre rapidement et facilement comment utiliser l’API sans avoir à faire appel à nos développeurs à chaque fois. Elle a été élaborée avec la supervision du Software Architect, le développeur en charge de l’API et l’Engineering Manager.
La documentation sur Postman contenait des exemples de requêtes courantes et des instructions détaillées sur la façon de les effectuer. Elle expliquait également les concepts clés de l’API, tels que les endpoints, les autorisations et les paramètres. De plus, la documentation a été mise à jour régulièrement pour inclure les nouvelles fonctionnalités et les modifications apportées à l’API.
Pour les utilisateurs de CMS
Après avoir identifié que les utilisateurs de CMS avaient des difficultés à intégrer notre API, j’ai décidé de créer une documentation dédiée pour chacun des CMS les plus courants, à savoir WordPress, Shopify, PrestaShop et Magento. Pour cela, j’ai utilisé Confluence, une plateforme de gestion de contenu collaboratif, qui m’a permis de regrouper toutes les informations et guides nécessaires dans un seul et même espace.
J’ai choisi de rédiger une documentation moins technique pour les utilisateurs de CMS, en me concentrant sur les étapes concrètes à suivre pour intégrer l’API sur leur site web. J’ai également inclus des exemples et des captures d’écran pour aider les lecteurs à visualiser les étapes à suivre. Cette approche a été très appréciée des utilisateurs de CMS qui ont pu enfin intégrer notre API sans difficulté et sans avoir besoin de faire appel à notre équipe technique. Voici un exemple pour les utilisateurs Wordpress:
Pour les équipes internes
Pour améliorer la compréhension et l'utilisation de l'API au sein des équipes internes, j'ai demandé au designer junior de mettre en place un processus clair et détaillé sur Google Slides. Cette plateforme a été choisie pour sa facilité d'utilisation et sa familiarité avec les membres de l'équipe. Le processus décrit le parcours du prospect depuis sa première demande d'information jusqu'à la résolution de son problème. Pour chaque étape, le processus indique les actions à entreprendre et les informations à fournir pour faciliter la compréhension et l'utilisation de l'API.
Le processus a été présenté et expliqué aux membres de l’équipe lors d’une réunion de formation. Des questions ont été posées et des échanges ont eu lieu pour s’assurer qu’ils comprennent parfaitement les actions à entreprendre pour répondre aux besoins des clients. Les processus ont également permis de réduire les erreurs et les temps de réponse, ce qui a entraîné une augmentation de la satisfaction des clients et une amélioration globale de leur expérience.
Conclusion
Grâce à la mise en place d’une documentation claire et facilement accessible, ainsi que des processus bien définis pour le support client, nous avons pu améliorer considérablement l’expérience des utilisateurs. En chiffres :
-40%
de temps passé par l’équipe de développement à aider les prospects grâce aux process.
-30%
de demandes d’aide chez les utilisateurs de CMS grâce à la documentation sur Confluence
+20%
de clients qui intègrent notre API dans leur code grâce à la documentation sur Postman
+15%
de taux de rétention des clients existants
Français 
English (UK)