Refine repository structure for KiCad 9 optimization

- Add dedicated /kicad/ directory with organized subdirectories for libraries, schematics, gerbers, plots, and backups
- Create comprehensive KiCad 9 library structure (symbols, footprints, 3D models)
- Add manufacturing-ready directories for production files (gerbers, drill, pick-and-place)
- Update all README files with KiCad-specific documentation and workflows
- Add KiCad-optimized .gitignore file for proper version control
- Create KICAD-PROJECT-TEMPLATE.md comprehensive usage guide
- Add hardware assembly documentation and BOM management
- Include detailed manufacturing file generation instructions
- Add docs structure with design-notes and user-manual directories
- Provide complete workflow from design to manufacturing with quality checklists
This commit is contained in:
2025-08-03 16:27:46 +07:00
parent dabbd358f8
commit 046f66f6eb
21 changed files with 1703 additions and 68 deletions

View File

@@ -1,3 +1,19 @@
# /hardware
Electrical design files including schematics, PCB layout, BOM, and simulations.
Hardware documentation and support files for your KiCad project.
## Purpose
This directory contains hardware-related documentation and files that support your KiCad design:
- Bill of Materials (BOM)
- Component datasheets
- Circuit simulations
- Assembly documentation
## Directory Structure
- `bom/` - Bill of Materials in various formats
- `datasheets/` - Component datasheets and specifications
- `simulations/` - SPICE simulations and analysis
- `assembly/` - Assembly drawings and instructions
## Note
Your main KiCad design files (`.kicad_pro`, `.kicad_sch`, `.kicad_pcb`) should be in the project root directory, with KiCad-specific files organized in the `/kicad/` directory.

View File

@@ -0,0 +1,81 @@
# /hardware/assembly
Assembly drawings and instructions for your KiCad project.
## Purpose
This directory contains assembly-related documentation and drawings that help with the physical construction of your PCB:
- Assembly drawings
- Component placement guides
- Assembly instructions
- Pick and place references
## File Types
- **`.pdf`**: Assembly drawings and instructions
- **`.png/.jpg`**: Assembly photos and diagrams
- **`.txt/.md`**: Text-based assembly instructions
- **`.csv`**: Component placement data
## Assembly Drawings from KiCad
1. Open your PCB (`.kicad_pcb`)
2. Go to **File → Plot**
3. Select layers for assembly:
- F.Fab (Front Fabrication)
- B.Fab (Back Fabrication)
- F.SilkS (Front Silkscreen)
- B.SilkS (Back Silkscreen)
4. Enable "Plot footprint values" and "Plot reference designators"
5. Set output directory and plot
## Recommended Assembly Files
```
assembly/
├── ProjectName-Assembly-Top.pdf # Top side assembly drawing
├── ProjectName-Assembly-Bottom.pdf # Bottom side assembly drawing
├── ProjectName-Assembly-Guide.pdf # Complete assembly instructions
├── ProjectName-Placement.csv # Component placement coordinates
├── assembly-photos/
│ ├── step1-power-components.jpg
│ ├── step2-mcu-section.jpg
│ └── step3-connectors.jpg
└── instructions/
├── assembly-checklist.md
├── soldering-notes.md
└── testing-procedure.md
```
## Assembly Drawing Guidelines
- Include component reference designators
- Show component values where helpful
- Indicate polarity for polarized components
- Mark pin 1 locations for ICs
- Include assembly notes and warnings
- Use different colors for different component types
## Assembly Instructions Content
- **Component list**: What components go where
- **Assembly order**: Sequence for efficient assembly
- **Special procedures**: Unique assembly steps
- **Soldering notes**: Temperature, time, flux requirements
- **Testing points**: Where to probe during assembly
- **Troubleshooting**: Common issues and solutions
## Pick and Place Data
Generate component placement data for automated assembly:
1. In KiCad PCB editor, go to **File → Fabrication Outputs → Component Placement**
2. Configure format (CSV recommended)
3. Include position, rotation, and side information
4. Save to this directory
## Quality Control
- **Assembly checklist**: Step-by-step verification
- **Visual inspection**: What to look for
- **Electrical testing**: Basic functionality tests
- **Rework procedures**: How to fix common mistakes
## Best Practices
- Create assembly drawings at 1:1 scale when possible
- Use clear, high-contrast colors
- Include revision information
- Document any special tools required
- Provide multiple views for complex assemblies
- Include photos of completed assembly

View File

@@ -1,3 +1,69 @@
# /hardware/bom
Bill of Materials in CSV or spreadsheet format.
Bill of Materials for your KiCad project.
## Purpose
This directory contains Bill of Materials (BOM) files generated from your KiCad schematic and additional BOM-related documentation.
## File Types
- **`.csv`**: Comma-separated values format (most common)
- **`.xlsx`**: Excel spreadsheet format
- **`.xml`**: XML format for automated processing
- **`.html`**: HTML format for web viewing
- **`.pdf`**: PDF format for documentation
## Generating BOM from KiCad
1. Open your schematic (`.kicad_sch`)
2. Go to **Tools → Generate Bill of Materials**
3. Select or configure a BOM plugin
4. Set output directory to `hardware/bom/`
5. Click **Generate**
## Recommended BOM Formats
### Basic BOM (`ProjectName-BOM.csv`)
- Reference designators
- Values
- Footprints
- Quantities
- Manufacturer part numbers
- Supplier part numbers
### Extended BOM (`ProjectName-BOM-Extended.xlsx`)
- All basic information plus:
- Descriptions
- Manufacturer names
- Supplier links
- Pricing information
- Stock availability
- Alternative parts
## BOM Structure Example
```
Reference | Value | Footprint | Qty | MPN | Supplier | SPN
----------|------------|------------------|-----|---------------|----------|-------------
R1,R2,R3 | 10k | R_0603_1608Metric| 3 | RC0603FR-0710KL| Digi-Key | 311-10.0KHRCT-ND
C1,C2 | 100nF | C_0603_1608Metric| 2 | GRM188R71C104KA01D| Mouser | 81-GRM188R71C104KA1D
U1 | STM32F401 | LQFP-64_10x10mm | 1 | STM32F401RET6 | Digi-Key | 497-11767-ND
```
## BOM Management Best Practices
- Include manufacturer part numbers (MPN)
- Add supplier part numbers for purchasing
- Include alternative/substitute parts
- Document any special requirements
- Update BOM with design changes
- Version control BOM files
- Include pricing and availability data
## KiCad BOM Plugins
- **bom_csv_grouped_by_value**: Groups components by value
- **bom_csv_sorted_by_ref**: Sorts by reference designator
- **kibom**: Advanced BOM generator with many options
- **InteractiveHtmlBom**: Creates interactive HTML BOMs
## File Naming Convention
- `ProjectName-BOM.csv` - Basic BOM
- `ProjectName-BOM-v1.0.csv` - Versioned BOM
- `ProjectName-BOM-Extended.xlsx` - Detailed BOM with pricing
- `ProjectName-BOM-Assembly.csv` - Assembly-specific BOM