Heex Technologies
Rédactrice Technique Senior Freelance — Documentation de SDK et fichiers Readme
Éléments clés
| Catégorie | Données |
|---|---|
| Organisation | Heex Technologies |
| Période | De mai à septembre 2021 |
| Domaine | Smart Data, edge computing, systèmes embarqués et mobilité autonome |
| Rôle | Rédactrice technique senior freelance |
| Périmètre | Extraction des connaissances, documentation SDK et API, schémas d'architecture, segmentation des publics et mise en œuvre du site |
| Publics | Équipes internes, développeurs, partenaires, clients, investisseurs et parties prenantes de Due Diligence |
| Langue | Anglais |
| Environnement | C++, JavaScript, API REST, Swagger, Docusaurus, Markdown, GitLab, Notion, Miro et Excalidraw |
Présentation du projet
Heex Technologies développe des solutions de Smart Data Management pour les systèmes autonomes et embarqués. Sa technologie edge-to-cloud permet aux organisations d'identifier et de collecter les événements de données pertinents, plutôt que de transférer sans distinction de grands volumes de données brutes.
Dans le cadre d'une mission de conseil de quatre mois, j'ai créé la première documentation technique de l'entreprise en anglais. Le projet couvrait le SDK embarqué, l'API REST, les concepts d'architecture, les workflows Smart Data et la mise en œuvre progressive d'un site de documentation dédié.
La documentation devait répondre à plusieurs objectifs stratégiques : faciliter l'onboarding des équipes internes, accompagner les développeurs et partenaires, présenter la solution aux prospects et fournir des éléments techniques fiables dans le cadre de Due Diligence.
Contexte
Aucune documentation technique unifiée n'existait au début de la mission. Les connaissances disponibles étaient réparties entre des schémas d'architecture, du code source C++ et JavaScript, des fichiers README dans les dépôts, des spécifications internes et des échanges avec l'équipe de développement.
Le défi consistait à reconstruire les concepts et le fonctionnement technique de la solution à partir de ces sources brutes, puis à organiser l'information pour des publics présentant des niveaux d'expertise très différents.
Heex étant alors une jeune entreprise technologique, la documentation devait également démontrer la maturité du produit et fournir une vision fiable de l'architecture, de l'approche de développement et des capacités d'intégration.
Principaux livrables
Extraction des connaissances techniques, documentation SDK et API
J'ai analysé les sources techniques disponibles afin d'identifier et de formaliser les concepts, composants, interfaces et workflows de la solution Smart Data de Heex.
Pour le SDK embarqué, j'ai travaillé directement à partir du code source C++, des bibliothèques, des modules, du contenu des dépôts et des spécifications internes afin de restructurer et d'enrichir la documentation développeur.
Pour l'API REST, j'ai analysé les contrôleurs et routes JavaScript afin de produire :
- un guide d'utilisation structuré de l'API ;
- une documentation de référence Swagger ;
- des explications sur les principales ressources et opérations ;
- des conseils d'intégration destinés aux développeurs.
J'ai également rédigé des contenus conceptuels consacrés au Smart Data Management, à la Data Curation, à l'edge computing et au cloud computing, aux systèmes embarqués et au continuum informatique.
Des schémas d'architecture et illustrations originales ont été créés afin de clarifier les composants du système, les flux de données et les relations entre les environnements embarqués et cloud.
Plateformes documentaires et segmentation des publics
Dans une première phase, j'ai conçu un espace de travail Notion combinant publication documentaire et coordination du projet.
Cet espace proposait :
- un référentiel central pour les contenus techniques et les ressources visuelles ;
- des roadmaps documentaires et des tableaux de bord collaboratifs ;
- des accès différenciés pour les parties prenantes internes et externes ;
- un environnement structuré pour l'onboarding et la Due Diligence.
Cette solution légère était adaptée au niveau de maturité de l'entreprise et a permis de mettre la documentation technique à disposition avant que la plateforme documentaire définitive ne soit prête.
Dans une deuxième phase, j'ai conçu et mis en œuvre le site officiel de documentation avec Docusaurus et Markdown.
L'architecture de l'information était organisée selon des niveaux progressifs :
- concepts d'introduction sur le produit et informations publiques ;
- conseils avancés d'utilisation et d'intégration ;
- documentation experte sur le SDK et l'API.
Cette structure a permis de réutiliser et d'enrichir les contenus initiaux tout en adaptant la profondeur, la terminologie et le niveau de détail technique à chaque public.
Mon rôle
J'ai piloté le projet documentaire depuis l'extraction des connaissances brutes jusqu'à la publication, en combinant analyse du code source, architecture documentaire, rédaction technique, documentation API et SDK, explication visuelle et mise en œuvre du site.
La mission m'a demandé de m'adapter à la fois à un sujet technique complexe et aux besoins stratégiques d'une jeune entreprise, pour laquelle la documentation soutenait l'adoption du produit, l'onboarding interne, l'engagement des partenaires, la communication client et les processus de Due Diligence technique.
Technologies et outils
C++, JavaScript, API REST, Swagger, Docusaurus, Markdown, GitLab, Git, Visual Studio Code, Notion, Miro, Excalidraw, HTML et CSS.
Confidentialité
La documentation que j'ai créée n'est plus accessible publiquement dans sa forme d'origine. La documentation actuelle de Heex a depuis été entièrement repensée pour accompagner l'évolution du produit.
Cette page présente donc le périmètre, la méthodologie et l'expertise mobilisée, sans reproduire de contenus techniques confidentiels ou archivés.
© Florence Venisse, Experte en Documentation Technique & IA – Version révisée le 21/07/2026.