Smart Data Management
🏢 Client Overview
Heex Technologies is a Paris-based start-up specializing in Smart Data Management for autonomous systems. Its edge-to-cloud solution enables the targeted collection of meaningful data from embedded systems, transforming raw inputs into actionable insights through a dedicated SaaS platform. By helping engineering teams transition from Big Data to Smart-Data, Heex accelerates AI development and enhances operational efficiency across robotics, mobility, and industrial applications.
📇 Key Elements
| Category | Data |
|---|---|
| Client | Heex Technologies |
| Project Years | 2021 |
| Language | English |
| Tools and Frameworks | Docusaurus 2 |
| Approach | Docs-as-code methodology |
| Expertise | API documentation (REST APIs) |
| Collaboration Mode | Direct collaboration (no intermediary) |
🧩 Project Overview
A two-phase mission to design and deliver Heex Technologies’ first technical documentation in English –covering its Smart Data Management solution for embedded systems and cloud-based analytics.
Source-Based Documentation
As Senior Technical Writer & Consultant, I was tasked with documenting two core components of the Heex platform:
-
For the SDK component, I searched directly within the C++ codebase—modules and libraries—to design, structure, and write a comprehensive README for the GitLab repository.
-
For the REST API, I analyzed all JavaScript files related to HTTP controllers and routes to create both the Swagger reference documentation and the user guide.
-
For both components, I created numerous architecture diagrams based on Heex’s original Miro specifications –simplifying complex concepts to ensure clarity for a mixed audience of developers and business stakeholders.
Consulting Activity
To complement the technical writing mission, I designed and implemented a dedicated Notion Workspace for Heex, tailored to their documentation needs. This served as both a public-facing showcase of the documentation and an internal project hub –featuring a roadmap, collaborative dashboards, and a centralized repository for text and image assets.
Thanks to Notion’s flexible access controls, the workspace supported selective sharing with stakeholders while maintaining editorial integrity.
Given Heex’s position as a seed-stage start-up, this lightweight solution provided a practical and scalable alternative to a full documentation website.
It also proved instrumental in supporting Technical Due Diligence, offering clear visibility into product maturity and development workflows –especially valuable before full platform finalization.
Documentation Website & Audience Segmentation
In the second phase, I built the official Heex Documentation Website using Docusaurus v2, architected around three progressive reading levels:
- Public: Introductory concepts and product overview.
- Advanced: Technical usage and integration guidance.
- Expert: In-depth SDK and API documentation.
I adapted and expanded content from Phase 1, tailoring it to each audience tier while maintaining clarity across inherently complex topics.
I authored technical articles on Data Curation, Edge Computing, Cloud Computing, the Computing Continuum, and Embedded Systems –clarifying complex concepts and architectural principles.
To support comprehension, I also created targeted illustrations that visualize Heex’s core mechanisms and Smart Data workflows, bridging the gap between abstract ideas and practical understanding.
👩💻 My Role
As Senior Technical Writer & Consultant, I led the end-to-end creation of Heex Technologies’ technical documentation from raw assets –Miro diagrams, C++ and JavaScript codebases, and internal specifications.
I authored comprehensive guides for the embedded SDK and REST API, building developer-facing materials directly from source code while designing architecture diagrams to clarify complex concepts for both technical and business audiences.
Beyond content creation, I introduced Notion as a documentation and project workspace, enabling public access and internal collaboration. This strategic choice supported Heex through its early growth phase, including technical due diligence and team onboarding.
In Phase 2, I launched a documentation website using Docusaurus v2, segmenting content by expertise level and reinforcing the company’s maturity with professional styling, visual assets, and GitLab-driven versioning.
🛰️ Technologies & Tools
C++ and JavaScript source code analysis, Swagger, VVisual Studio Code, Docusaurus, Markdown, GitLab, Notion, Miro, Excalidraw
🔗 Link to Final Site
This documentation was previously unavailable to the public and is now archived, so it cannot be included in my portfolio. The current version, available on the Heex website, has been entirely redesigned to reflect updates to the Heex solution.