kidoc

What problem does it solve?

This Skill automates the generation of professional engineering documentation from KiCad projects, significantly reducing the time and effort required to produce comprehensive design documents.

Core Features & Use Cases

• Documentation Generation: Automatically generates Hardware Design Descriptions (HDD), CE Technical Files, Interface Control Documents (ICD), and Manufacturing Transfer Packages.
• Automated Analysis: Performs schematic, PCB, EMC, and thermal analyses to ensure compliance and identify potential issues.
• Custom Reports: Supports custom report generation with specified sections and formatting.
• Use Case: For an engineer working on a complex KiCad project, this Skill can automatically generate a comprehensive design review package, saving days of manual work.

Quick Start

Run the kidoc_scaffold.py script with the following command:

python3 skills/kidoc/scripts/kidoc_scaffold.py \
  --project-dir /path/to/kicad/project \
  --type hdd \
  --output reports/HDD.md