kidoc

Generate engineering documentation from KiCad project files as structured markdown reports.

Updated May 14, 2026
One-click install
npx skills add https://github.com/Dropio12/Cherry-Hardware-Agent --skill kidoc
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: kidoc
Source: https://github.com/Dropio12/Cherry-Hardware-Agent/tree/main/skills/kidoc
Command: npx skills add https://github.com/Dropio12/Cherry-Hardware-Agent --skill kidoc

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill requires matplotlib, svglib, python-docx, odfpy, Pillow, reportlab, and includes scripts (resource) and references (resource) and assets (resource) components.

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

Frequently Asked Questions about kidoc

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I generate engineering documentation from KiCad project files?

You can generate engineering documentation from KiCad project files by running the kidoc scaffold script, which auto-runs analyses, renders schematics and PCBs, and outputs structured markdown reports.

What types of compliance and manufacturing reports can I automate for hardware design?

For hardware design, you can automate generating Hardware Design Descriptions, CE Technical Files, Interface Control Documents, and Manufacturing Transfer Packages from KiCad projects.

Do I need Python to create a KiCad design review package?

Yes, you need Python 3.9 or higher to run the scripts that parse KiCad files, perform automated schematic and PCB analysis, and produce custom design review packages.

What's the best way to automate EMC and thermal analysis for KiCad schematics?

The best way to automate EMC and thermal analysis for KiCad schematics is using a documentation Skill that integrates internal parsing libraries to identify compliance issues and render structured markdown reports.

Can I customize the sections and formatting of generated hardware design descriptions?

Yes, you can customize hardware design descriptions by specifying desired sections and formatting, allowing the script to generate tailored markdown reports for your engineering documentation needs.

What are the limitations of automated schematic and PCB rendering for manufacturing transfer?

Automated schematic and PCB rendering for manufacturing transfer depends on provided KiCad files and optional analysis JSONs, requiring specific Python dependencies like python-docx and reportlab to function properly.