Recherche d'un rédacteur technique pour documenter notre API

Notre entreprise a construit une API REST que les développeurs partenaires utilisent pour s'intégrer à notre plateforme, mais la documentation actuelle est obsolète et éparpillée sur des wikis internes et d'anciens tableurs. Nous recherchons un rédacteur technique expérimenté qui peut transformer nos points de terminaison existants en une référence propre et structurée sur laquelle les développeurs peuvent compter sans avoir à contacter notre équipe de support chaque fois qu'ils rencontrent un problème.

Le travail couvre chaque point de terminaison public : descriptions claires de ce que fait chaque méthode, une répartition complète des paramètres requis et optionnels avec types et valeurs par défaut, authentification et gestion des erreurs, et des exemples réalistes de requêtes et de réponses en JSON. Au-delà de la référence écrite, nous voulons une page de test interactive où les développeurs partenaires peuvent entrer leurs propres clés, envoyer des requêtes d'exemple et voir des réponses en direct directement dans le navigateur.

Nous pouvons fournir un accès à un environnement de staging, des notes internes existantes et une communication directe avec nos développeurs backend pour clarifier les points de terminaison délicats. Le candidat idéal a une expérience pratique avec les API REST, JSON, des schémas d'authentification tels que des jetons ou des clés API, et des outils pour créer des documents interactifs. Veuillez partager des exemples de documentation que vous avez écrite auparavant, ainsi qu'un calendrier estimé.

Livrables :
— référence structurée pour tous les points de terminaison et paramètres
— exemples de requêtes et de réponses pour chaque méthode
— page de test interactive pour les développeurs partenaires
— guide d'intégration court pour les nouveaux intégrateurs