3D Design and Planning
🏢 Client Overview
3DVIA, a brand within the Dassault Systèmes group, offers a suite of 3D modeling and visualization tools designed to enhance user experience across industries such as interior design, retail, and manufacturing.
Its solutions include platforms like HomeByMe, which enables consumers and professionals to create realistic 3D home layouts, and 3DVIA Composer, used to produce interactive product documentation and technical illustrations.
By combining intuitive design interfaces with cloud-based accessibility, 3DVIA empowers companies to streamline workflows, personalize customer engagement, and accelerate decision-making through immersive 3D environments.
📇 Key Elements
Category | Data |
---|---|
Client | 3DVIA, Dassault Systèmes |
Project Years | Winter 2019 - 2020 |
Language | English |
Tools and Frameworks | Docusaurus 1.x |
Approach | Docs-as-code methodology |
Expertise | Markdown and SSGs |
Collaboration Mode | Direct collaboration, (Montreal Associates for invoicing & payment) |
🧩 Project Overview
The work focused on the documentation of applications for kitchen designers "Home By Me for Kitchen Retailers".
This involved first authoring foundational documentation in Word for professional kitchen designers; then migrating legacy HTML documentation to a modern docs-as-code framework using Docusaurus v1, while also rewriting and expanding content to improve clarity, usability, and maintainability.
Authoring from Scratch in Word
I began by writing a comprehensive guide in Microsoft Word, aimed at professionals designing kitchen cabinets using the 3DVIA application suite. This documentation explained how to use the geometry editor, assembly tools, database interface, and customer-facing planner in a coordinated workflow.
To ensure clarity and relevance:
- I simulated the full process of creating a kitchen cabinet from A to Z.
- I placed myself in the role of various users –designers, assemblers, planners– to reflect real-world usage.
- I produced detailed screenshots and diagrams to support each step.
The guide served as a foundational reference for internal teams and external partners.
See the "Base Cabinet" documentation at Kitchen Tutorial / Base Cabinet
Migration to Docusaurus v1
Following the initial Word-based documentation, I led the migration to a Docusaurus v1 site:
- Defined the new documentation architecture and publishing workflow.
- Converted Word and legacy HTML content into Markdown.
- Advised collaborators on Markdown syntax and technical writing best practices.
- Worked closely with teams in France and India to ensure consistency and alignment.
Content Expansion & Tutorial Development
In parallel with the migration, I rewrote and expanded several sections:
- Conducted in-depth editorial reviews to restructure and clarify existing content.
- Created new diagrams and updated screenshots to reflect current workflows.
- Developed the "Base Cabinet" cross-functional tutorial.
- Ensured the content addressed both technical and business audiences.
All content was authored in Markdown using Visual Studio Code, optimized for integration into the Docusaurus framework.
API Documentation
Between the technical writing and the migration phases, I conducted a review of part of the OpenAPI documentation.
👩💻 My Role
As an experienced consultant and Senior Technical Writer, I was entrusted with the foundational documentation for the 3DVIA kitchen design tools –—authoring a professional guide from scratch for furniture designers using the HomeByMe suite. I led the editorial process independently, from writing to illustration, simulating real-world workflows to ensure the content was relevant, usable, and didactic.
Before this project, I had solid experience working with Hugo, and was already recognized as an expert in Markdown-based documentation workflows. That expertise made me the ideal choice to lead the migration from legacy HTML and Word materials into a Docusaurus v1 site. This was my first time using Docusaurus, and the project marked a significant milestone, as Docusaurus has become my preferred framework ever since.
It was also a complete immersion in the docs-as-code method, collaborating with other users on different branches of GitTea repository.
🛰️ Technologies & Tools
Docusaurus, Markdown, Sourcetree, GitTea, Visual Studio Code, Jira, Microsoft Word.
Assets created within the HomeByMe applications.
🔗 Link to Final Site
The website is now a Docusaurus v3 version.
See in particular the "Base Cabinet" documentation at Kitchen Tutorial / Base Cabinet