preloader
  • Documentation d'API, Rédaction technique et Traduction
  • English

Smart Data Management

Image

🧩 HEEX TECHNOLOGIES

Mission sans intermédiaire.

Heex Technologies est une start-up basée à Paris.

“Heex Technologies helps companies working on autonomous systems to better access the data that they need to deliver on the promise of artificial intelligence.”

La solution de Smart Data Management de Heex permet de collecter de la donnée ciblée sur des systèmes embarqués en edge computing, de les valoriser puis de les analyser dans une application SaaS.

Phase 2

Dans cette 2ème phase, j’ai créé le site Web de la Documentation de Heex (en anglais), avec 3 niveaux de lectures : “public”, “avancé” et “experts”.

  • Site réalisé avec Docusaurus V2. Architecture, structuration, adaptation aux 3 entrées différentes.
  • Rédaction du contenu à partir de l’existant rédigé en phase 1, souvent reformulation en fonction des trois types d’audience. Les contenus sont tous complexes par essence.
  • 57 nouveaux schémas réalisés avec Excalidraw.
  • Favicon, images, CSS, styling, etc.
  • Commit/push sur GitLab.

Mots clés de la mission

Data Management, Data Curation, Edge Computing, Cloud Computing, Computing Continuum, Embedded Systems, REST APIs, SaaS applications.

Ce site web n’est pas public et ne peut donc pas être consulté depuis mon Portfolio.

Phase 1

Projet

J’ai eu pour mission de créer la première documentation technique (en anglais) de la solution Heex, à partir de schémas Miro et du code source.

Rédactrice Technique Senior

Cette documentation concernait deux des trois éléments de la solution Heex, ceux au plus proche du code : le SDK pour les systèmes embarqués et l’API REST de distribution entre le backend et le frontend.

  • Pour la partie SDK, j’ai du remonter l’information du code C++ lui-même (modules et librairies) pour concevoir, structurer et rédiger un Readme complet fourni dans le repository sur GitLab.
  • Pour la partie API REST, j’ai du parcourir tous les fichiers javascript des contrôleurs HTTP et des routes pour créer la documentation de référence du Swagger, et la documentation utilisateur.
  • Pour les deux, j’ai du réaliser de très nombreux schémas d’architectures à partir des schémas de spécifications réalisés sous Miro par Heex. Il s’agissait là d’un travail de simplification d’une pensée complexe, avec pour destinataires aussi bien des développeurs que des business partners.

Activité de conseil

En plus de cette mission, j’ai créé pour Heex un Workspace Notion dédié à la Documentation afin de fournir une vue publique de mon travail de documentation (Notion a une gestion des accès très pertinente), et d’avoir un espace de gestion de mon projet similaire à Jira : Roadmap, dashboards collaboratifs, base de données de contenu texte et images, etc. Dans la phase de démarrage où se trouve Heex actuellement, une documentation sous Notion constitue une excellent alternative à un site web documentaire.

Ce type de Workspace est également très utile pour une jeune start-up pour passer sa Technical Due Diligence, la documentation jouant un rôle d’autant plus majeur que les développements ne sont pas finalisés.

Mots clés de la mission

Notion, SDK (C++), REST API (Javascript et JSON), Swagger, Visual Studio Code, Markdown, GitLab, Sourcetree, Miro, Notion, Draw.io, anglais.

Cette documentation n’est pas publique et ne peut donc pas être consultée depuis mon Portfolio.