CommunityCAD
Documenting your model
Descriptions, images, datasheets, tags and versions that make a model useful.
A model with good documentation gets downloaded, printed, rated well and supported. One without it gets skipped. This page covers each part of a model's documentation.
Description or README#
The Description tab shows:
- the README from your ZIP, if there is one (how), or
- the description you write in the upload or edit form.
Both use Markdown: headings, lists, bold, links, tables, code blocks and images from web addresses.
Cover what it is, what it needs, how to make it and how to use it. For 3D prints, say what material, layer height, infill and supports you used, and the orientation. For machined or laser-cut parts, say the material and thickness.
Images#
Add up to 20 images (PNG, JPEG, GIF or WebP, 5 MB each) when uploading, or later with Edit model. Drag to reorder; the first image is the thumbnail everywhere on the site.
- Put a photo of the real, made thing first if you have one.
- Show it in use, assembled, and any tricky step.
- Automatic renders are added after your images. They're useful, but a real photo builds more trust.
Images are stored as uploaded. Remove location data from phone photos first.
Datasheets#
PDFs (up to 20 MB) uploaded as documents, added with Edit model, or placed in a ZIP's docs/ folder become datasheets. On the model page:
- they can be read in place (Files tab →
docs/), with a toggle to view the recognised text; - an excerpt appears under the model;
- each one gets its own page that search engines can find;
- their text helps semantic search find your model.
Datasheets are ideal for component specs, assembly guides and manuals.
Tags#
Tags help people find your model and filter search results. Use 3 to 8 specific ones: what it is (enclosure), what it fits (raspberry pi 5), how it's made (3d print, laser cut, cnc). The search categories (3D Print, CNC, Laser Cut, Electronics, Robotics, Automotive, Aerospace, Hardware) are tags, so include the ones that apply.
Tags are set at upload and can't be edited afterwards yet.
License#
Always choose one. Without a license, people can look but have no permission to reuse your work. See Choosing a license.
Versions and changelogs#
When you improve a model, upload a new version with a short changelog rather than a new model. Everyone keeps the same link, ratings and comments, and can see what changed. See Versions and editing.
Accuracy ratings reward documentation#
People rate models on five dimensions, and one is Documentation quality. Good ratings also count toward earning a membership tier.