preloader
  • API Documentation, Technical Writing & Translations
  • Français

3D Design and Planning

project image

3DVIA


3DVIA is a company inside the group Dassault Systèmes.

“3DVIA provides enterprises and consumers, smart 3D space planning solutions that enable new ways to engage, consider, and make the best choice.”

3DVIA provides international companies and their customers with kitchen design (Home By Me for Kitchen Retailers) and interior design (Home By Me for Home Retailers) solutions in 3D. It also offers the general public a 3D planning website: Home By Me.

3DVIA has developed four applications: a 3D geometry application for the integration and modification of assets, an application for assembling the different components of a kitchen furniture, an application for interfacing with the database. As well as a kitchen planning application that can be integrated into the partner’s website.

Project

The work focused on the documentation of applications for kitchen designers “Home By Me for Kitchen Retailers”. This involved supporting the migration of existing documentation in HTML to Docusaurus as well as completely rewriting certain sections.

Documentation migration to Docusaurus v1:

  • Definition of the new architecture and process
  • Conversion from HTML to Markdown
  • Advice on Markdown and good practices in technical writing for collaborators called to publish directly on Docusaurus
  • Working in collaboration with the teams on site and in India.

Technical writing in English:

  • In-depth review of complete sections of the existing documentation: rewriting, restructuring, new diagrams, new screenshots, etc.
  • Writing “from scratch” of a transversal tutorial using all 3DVIA applications of geometry, assembly, interface with the database and the kitchen planner for the end customer.
  • Creation of a piece of furniture from A to Z (when the Technical Writer has to put her(him)self in the place of the different professionals who use the applications) and make numerous screenshots.

Review of part of the API.

The Home By Me for Kitchen Retailers Documentation

The work was mainly done in Markdown in Visual Studio Code for integration into Docusaurus v1.

The Home By Me for Kitchen Retailers documentation 🔗