Documenter un système mécanique

Des plans qu'on peut vraiment réutiliser, pas juste regarder

Documenter un système mécanique

Documenter votre partie mécanique avec des vues claires du modèle, une nomenclature de pièces, et les choix de matériaux et de tolérances.

Durée :
Difficulté :

Logiciels :

Machines/Outils :

Documentation réalisée à 55% 55
Créée par :  Adrien Bracq
  Le site de votre projet n'est pas ce site-ci

Votre repo de projet utilise le thème Just the Docs, pas le thème de ce site de documentation MakerSpace. Certaines fonctionnalités visibles ici (visionneuse 3D interactive) ne sont pas disponibles chez vous par défaut. Ce tutoriel explique la méthode qui fonctionne toujours (des images), et une méthode plus avancée en option.

Ce qu’il faut documenter

Au-delà du modèle 3D lui-même : le matériau choisi et pourquoi, les tolérances importantes (un jeu trop serré ne s’imprime pas, un jeu trop large devient instable), et les pièces qui ont demandé plusieurs itérations — voir Prototyper et itérer.

Méthode simple : exporter une image de votre modèle

C’est la méthode qui marche toujours, sans rien installer de plus.

Étape 1 — Cadrer la vue

Dans votre logiciel de CAO, positionnez la vue 3D comme vous voulez qu’elle apparaisse dans la documentation (orientation, zoom). Sous FreeCAD, utilisez les vues prédéfinies (isométrique, face, dessus…) accessibles dans le menu Affichage pour un cadrage propre et reproductible.

Étape 2 — Exporter en image

Sous FreeCAD : menu Outils > Enregistrer une image… (Tools > Save picture…). Choisissez un nom de fichier, un format (PNG), et éventuellement une taille standard dans la liste déroulante, puis Enregistrer.

Sous OnShape : clic droit sur la vue 3D, Enregistrer sous forme d’image, ou utilisez la fonction de capture native du logiciel.

Sous SolidWorks : Fichier > Enregistrer sous, choisissez un format image (PNG, JPEG).

Étape 3 — Intégrer l'image dans votre page

Copiez l’image dans le dossier de votre page docs/ (par exemple docs/images/), puis dans votre fichier Markdown :

![Vue du châssis](images/chassis.png)

Répétez l’opération pour chaque pièce ou vue importante (vue éclatée, détail d’un assemblage).

Pour aller plus loin : modèle 3D interactif (optionnel, plus avancé)

  Réservé à ceux qui veulent creuser

Cette section demande de modifier un fichier de configuration de votre site (_includes/head_custom.html) — pas obligatoire, une image suffit largement pour la plupart des projets.

Le composant <model-viewer> (développé par Google) permet d’afficher un modèle 3D manipulable (rotation, zoom) directement dans une page web, sans rien télécharger — un simple lien vers un fichier hébergé en ligne.

Étape 1 — Activer le script sur toutes les pages

Créez le fichier docs/_includes/head_custom.html (créez le dossier _includes s’il n’existe pas encore) avec ce contenu :

<script type="module" src="https://unpkg.com/@google/model-viewer/dist/model-viewer.min.js"></script>

Just the Docs charge automatiquement ce fichier sur chaque page — c’est le point d’extension officiel du thème pour ajouter du script.

Étape 2 — Utiliser la balise dans vos pages

Exportez votre assemblage au format .glb depuis votre logiciel de CAO (FreeCAD : Fichier > Exporter, format glTF ; OnShape : export direct en glTF depuis le menu contextuel du document). Copiez le fichier dans le dossier de votre page, puis :

<model-viewer src="assemblage.glb" alt="Mon assemblage" camera-controls auto-rotate style="width: 100%; height: 400px;"></model-viewer>

La nomenclature des pièces

Copier le gabarit de nomenclature (Markdown)
| Pièce | Matériau | Quantité | Procédé | Remarque |
|---|---|---|---|---|
| Support capteur | PLA | 1 | Impression 3D | Tolérance +0.2mm sur le logement |
| Axe de rotation | Acier inox | 1 | Achat commerce | Diamètre 6mm |
| Châssis | Contreplaqué 5mm | 1 | Découpe laser | ... |

Photos de l’assemblage réel

Comme pour l’électronique, le modèle CAO montre l’intention — une photo montre ce qui a vraiment été assemblé, avec les ajustements faits en cours de route.

Exercice

Exportez une image de votre modèle et intégrez-la dans votre page, remplissez une nomenclature avec vos pièces réelles (matériau, procédé, tolérances importantes).