A revision change is triggered by any change in:
- Form (appearance)
- Fit
- Function
Most of the time, if the drawing changed, the revision should change.
A revision change is triggered by a:
- Major form change
- Can the average customer tell the difference from afar?
- Minor fit change
- End user change like different mounting holes
- Internal change so that parts from older units are not cross-compatible
- Major function change
- Is the performance noticeably different to the average customer?
Format: [PROJECT]-[TYPE]-[PART-NAME]-[SIZE]-[R1]
PROJECT: Project/product name such as T100
, BROV2
, PING
. If the part or cable is widely applicable to different products, consider using the MISC
project name.
TYPE: Part type, usually one of the following:
3D
: 3D printed partASM
: Assembly or subassemblyCAB
: CablesELEC
: Electrical component or PCB assemblyF
: FastenerM
: Metal partP
: Plastic partR
: Rubber partSTICKER
: Sticker or labelW
: Wood or paper product
PART-NAME: Part name in human readable format, all capital, no spaces. This should be concise but completely clear. We typically use the same name that we call the product, such as END-CAP
or SPOOL-FLANGE
.
SIZE: Optional size attribute, usually S | M | L | XL or an important measurement like 6MM. If including a measure, include the units, such as 6MM
or 200G
. Multiple size attributes can be included if necessary to convey the full part description.
R1: Revision number. Typically, X1
, X2
, etc are used for prototypes and design iterations. The first released version of the product is marked as R1
. Subsequent public releases of the part or assembly are marked as R2
, R3
, etc. See the Revision Change Guidelines above.
RP: Retail packaging (i.e. part in bag with any accessories)
BAR30-CAB-WIRE-RED-12IN-R1
For cable harnesses that are specific to one product only and are unlikely to be reused, the format should follow the standard format above, i.e.
SS1-CAB-MOTOR-R1
Screws are named with an alternative format that does not include the PROJECT
prefix, since they are often used in multiple places.
Format: [THREAD]-[LENGTH]-[MATERIAL]-[TYPE]
Example: M3X0.5-12-SS316-SOCKET-HEAD-CAP-SCREW
O-rings are named with an alternative format.
Format: ORING-[SIZE]-[MATERIAL]-[HARDNESS]
Example: ORING-240-BUNA-70A
Plastic and paper bags use the following format. Type can be ZIP
, BUBBLE
, STATIC
, etc.
Format: BAG-P-[SIZE]-[TYPE]
Example: BAG-P-2X3-ZIP
Boxes use the following format:
Format: BOX-W-[SIZE]-[TYPE]
Example: BOX-W-5X5X3