Gestion intelligente des données
🏢 Présentation du client
Heex Technologies est une start-up parisienne spécialisée dans la gestion intelligente des données (Smart Data Management) pour les systèmes autonomes. Sa solution edge-to-cloud permet la collecte ciblée de données pertinentes depuis des systèmes embarqués, transformant les entrées brutes en informations exploitables via une plateforme SaaS dédiée. En aidant les équipes d’ingénierie à passer du Big Data au Smart Data, Heex accélère le développement de l’IA et améliore l’efficacité opérationnelle dans les domaines de la robotique, de la mobilité et des applications industrielles.
📇 Éléments clés
Catégorie | Données |
---|---|
Client | Heex Technologies |
Année du projet | 2021 |
Langue | Anglais |
Outils et frameworks | Docusaurus 2 |
Approche | Méthodologie docs-as-code |
Expertise | Documentation d’API (API REST) |
Mode de collaboration | Collaboration directe (sans intermédiaire) |
🧩 Présentation du projet
Une mission en deux phases visant à concevoir et livrer la première documentation technique de Heex Technologies en anglais – couvrant sa solution de gestion intelligente des données pour systèmes embarqués et analyses cloud.
Documentation basée sur le code source
En tant que rédactrice technique senior & consultante, j’ai été chargée de documenter deux composants clés de la plateforme Heex :
-
Pour le SDK, j’ai exploré directement le code C++ — modules et bibliothèques — afin de concevoir, structurer et rédiger un README complet pour le dépôt GitLab.
-
Pour l’API REST, j’ai analysé tous les fichiers JavaScript liés aux contrôleurs HTTP et aux routes pour créer à la fois la documentation de référence Swagger et le guide utilisateur.
-
Pour les deux composants, j’ai créé de nombreux schémas d’architecture basés sur les spécifications Miro d’origine de Heex – simplifiant les concepts complexes pour garantir la clarté auprès d’un public mixte de développeurs et de parties prenantes métier.
Activité de conseil
En complément de la mission de rédaction technique, j’ai conçu et mis en place un espace de travail Notion dédié à Heex, adapté à leurs besoins documentaires. Cet espace servait à la fois de vitrine publique pour la documentation et de hub interne de projet – incluant une feuille de route, des tableaux collaboratifs et un dépôt centralisé pour les contenus texte et image.
Grâce aux contrôles d’accès flexibles de Notion, l’espace permettait un partage sélectif avec les parties prenantes tout en maintenant l’intégrité éditoriale.
Étant donné la position de Heex en tant que start-up en phase d’amorçage, cette solution légère offrait une alternative pratique et évolutive à un site de documentation complet.
Elle s’est également révélée précieuse pour les audits techniques (Technical Due Diligence), offrant une visibilité claire sur la maturité produit et les workflows de développement – particulièrement utile avant la finalisation complète de la plateforme.
Site de documentation & segmentation des publics
Lors de la deuxième phase, j’ai construit le site officiel de documentation Heex avec Docusaurus v2, structuré autour de trois niveaux de lecture progressifs :
- Public : Concepts introductifs et présentation du produit.
- Avancé : Guide d’utilisation technique et d’intégration.
- Expert : Documentation approfondie du SDK et de l’API.
J’ai adapté et enrichi le contenu de la Phase 1, en le personnalisant pour chaque niveau tout en maintenant la clarté sur des sujets intrinsèquement complexes.
J’ai rédigé des articles techniques sur la curation de données, l’Edge Computing, le Cloud Computing, le continuum informatique et les systèmes embarqués – clarifiant les concepts complexes et les principes architecturaux.
Pour faciliter la compréhension, j’ai également créé des illustrations ciblées visualisant les mécanismes clés de Heex et les workflows Smart Data, comblant le fossé entre idées abstraites et compréhension pratique.
👩💻 Mon rôle
En tant que rédactrice technique senior & consultante, j’ai piloté la création complète de la documentation technique de Heex Technologies à partir de ressources brutes – schémas Miro, bases de code C++ et JavaScript, et spécifications internes.
J’ai rédigé des guides complets pour le SDK embarqué et l’API REST, en produisant des contenus destinés aux développeurs directement à partir du code source, tout en concevant des schémas d’architecture pour clarifier les concepts complexes auprès des publics techniques et métier.
Au-delà de la création de contenu, j’ai introduit Notion comme espace documentaire et de gestion de projet, permettant un accès public et une collaboration interne. Ce choix stratégique a soutenu Heex durant sa phase de croissance initiale, notamment pour les audits techniques et l’intégration des équipes.
Lors de la Phase 2, j’ai lancé un site de documentation avec Docusaurus v2, segmentant le contenu par niveau d’expertise et renforçant la maturité de l’entreprise grâce à un style professionnel, des visuels adaptés et un versioning piloté par GitLab.
🛰️ Technologies & Outils
Analyse de code source C++ et JavaScript, Swagger, Visual Studio Code, Docusaurus, Markdown, GitLab, Notion, Miro, Excalidraw
🔗 Lien vers le site final
Cette documentation n’était auparavant pas accessible au public et est désormais archivée, elle ne peut donc pas être incluse dans mon portfolio. La version actuelle, disponible sur le site de Heex, a été entièrement repensée pour refléter les évolutions de la solution Heex.