- Add FILE-NAMING-AND-VERSIONING.md with complete Semantic Versioning 2.0.0 and Harvard Data Management file naming conventions - Update README.md with file naming standards and semantic versioning workflow - Update KICAD-PROJECT-TEMPLATE.md with comprehensive file naming examples and git workflow - Update hardware/bom/README.md with standardized BOM file naming conventions - Update manufacturing/gerbers/README.md with production-ready Gerber file naming - Update mechanical/stl/README.md with 3D printing file naming including material suffixes - Implement YYYY-MM-DD date format and hyphen-separated naming throughout - Add versioning strategies for hardware, software, and documentation components - Include git tagging strategy and release management guidelines - Provide comprehensive examples for all file types and directories
/mechanical
Mechanical design files for all physical components and sub-assemblies.
Purpose
This directory contains mechanical design files for the complete physical system, including multiple sub-assemblies, enclosures, mounting hardware, and mechanical interfaces.
Directory Structure
cad/- Editable CAD models and assembliesdrawings/- 2D technical drawings and specificationsenclosure/- Housing and case designsstl/- 3D printable files for all components
Sub-Assembly Organization
For projects with multiple mechanical sub-assemblies, organize by function:
mechanical/
├── cad/
│ ├── main-assembly/ # Complete system assembly
│ ├── pcb-mount/ # PCB mounting and brackets
│ ├── sensor-housing/ # Sensor enclosures and mounts
│ ├── connector-panel/ # Connector panels and interfaces
│ ├── cooling/ # Heat sinks, fans, thermal management
│ └── fasteners/ # Custom bolts, spacers, hardware
├── drawings/
│ ├── assembly-drawings/ # Overall assembly drawings
│ ├── detail-drawings/ # Individual part drawings
│ ├── interface-drawings/ # Mating part specifications
│ └── manufacturing-drawings/ # Fabrication specifications
├── enclosure/
│ ├── main-housing/ # Primary enclosure
│ ├── sub-enclosures/ # Secondary housings
│ └── covers-panels/ # Removable covers and access panels
└── stl/
├── enclosure-parts/ # 3D printable enclosure components
├── mounting-hardware/ # Custom brackets and mounts
├── prototyping/ # Prototype and test fixtures
└── tooling/ # Assembly jigs and fixtures
File Types
- CAD Files: Native CAD formats (.sldprt, .step, .iges, .f3d)
- Drawings: PDF technical drawings and DXF files
- 3D Models: STL files for 3D printing, STEP for manufacturing
- Assembly Files: Complete system assemblies and sub-assemblies
Design Considerations
- Modularity: Design for easy assembly and maintenance
- Manufacturing: Consider fabrication methods and tolerances
- Materials: Document material specifications and requirements
- Interfaces: Define mechanical interfaces between sub-assemblies
- Thermal: Account for heat dissipation and airflow
- Accessibility: Ensure access for assembly, service, and repair
CAD File Management
- Use consistent naming conventions across all files
- Maintain assembly hierarchy and relationships
- Include material properties and finish specifications
- Document design intent and critical dimensions
- Version control CAD files with descriptive commit messages
Manufacturing Integration
- Coordinate with PCB dimensions and mounting holes
- Consider assembly sequence and tooling requirements
- Define tolerances and critical dimensions
- Specify surface finishes and treatments
- Include inspection and quality requirements
Documentation Requirements
- Assembly instructions and procedures
- Bill of materials for mechanical components
- Interface specifications and mating requirements
- Manufacturing and fabrication notes
- Testing and validation procedures