Documentation and file conventions¶
An identifier answers “Which exact kind of item is this?” It must not depend on supplier, price, storage location, or assembly step.
Pattern¶
Use CATEGORY-MODULE-NUMBER for custom items:
PRT-FDR-001— custom feeder housingPCB-FDR-001— custom feeder PCB
Use CATEGORY-SPECIFICATION for interchangeable standard hardware shared by modules:
FST-M3X8-SHCS— M3 × 8 mm socket-head cap screwFST-NUT-M3-HEX— M3 hex nut
Categories¶
Prefix |
Category |
Includes |
|---|---|---|
|
Module |
Feeder, screen, tunnel, light, frame |
|
Custom mechanical part |
3D-printed, laser-cut, or machined pieces |
|
Circuit board |
Bare or assembled custom PCB |
|
Cable assembly |
A finished cable with defined length and terminations |
|
Connector item |
Housing, crimp contact, header, socket, terminal |
|
Fastening hardware |
Screws, nuts, washers, inserts, spacers, standoffs |
|
Other purchased component |
Motor, screen, sensor, hinge, power supply |
|
Raw material |
Plexiglass sheet, filament, bulk wire, tubing |
|
Adhesive/chemical |
Threadlocker, glue, solder, flux, grease |
|
Tool |
Hex key, crimp tool, soldering iron, multimeter |
|
Media |
Photograph, video, diagram |
|
Test |
Defined procedure with a pass criterion |
Screws, nuts, washers, and inserts¶
All belong to FST because they are fastening hardware. Examples:
ID |
Meaning |
|---|---|
|
M3 standard hex nut |
|
M3 flat washer |
Revisions and document versions¶
Hardware revisions identify physical compatibility:
A,B,C.Document versions identify editorial releases:
1.0,1.1,2.0.Every page states the applicable module/hardware revision.
Media filenames¶
Use: <module-id>_<step>_<action>_<view>.<ext>
Examples:
mod-fdr_03_install-motor_top.jpgmod-fdr_04_route-cable_close.jpgmod-fdr_05_check-rotor-motion_demo.mp4