Skip to content

Add hardware-design-workflow orchestrating template#193

Merged
Alan-Jowett merged 3 commits intomicrosoft:mainfrom
Alan-Jowett:add-hardware-design-workflow
Apr 6, 2026
Merged

Add hardware-design-workflow orchestrating template#193
Alan-Jowett merged 3 commits intomicrosoft:mainfrom
Alan-Jowett:add-hardware-design-workflow

Conversation

@Alan-Jowett
Copy link
Copy Markdown
Member

Summary

Add the \hardware-design-workflow\ template — the end-to-end orchestrator that guides users from initial idea to manufacturable PCB artifacts. This is Step 8 of 9, and the capstone of the hardware design workflow.

New Components

Type Name Path Description
Template (interactive) hardware-design-workflow templates/hardware-design-workflow.md End-to-end: requirements -> components -> schematic -> PCB -> manufacturing

Changes to Existing Components

Updated \�pplicable_to\ on all 8 hardware protocols to include \hardware-design-workflow\ (and \design-schematic\ where applicable). Removed standalone composition notes from protocols that now have template references.

Protocol Change
component-selection \�pplicable_to: [design-schematic, hardware-design-workflow]\
component-selection-audit \�pplicable_to: [design-schematic, hardware-design-workflow]\
schematic-design \�pplicable_to: [design-schematic, hardware-design-workflow]\
schematic-compliance-audit added \design-schematic, hardware-design-workflow\
pcb-layout-design added \hardware-design-workflow\
layout-design-review added \hardware-design-workflow\
manufacturing-artifact-generation added \hardware-design-workflow\

Design Decisions

  • 10 protocols composed into a single interactive session — the most protocol-dense template in the library.
  • 9-phase workflow with human-in-the-loop gates at every transition. Modeled on \�ngineering-workflow\ but domain-specific.
  • Full loop-back support: Components -> Schematic -> Layout feedback loops, matching real hardware design iteration patterns.
  • **\ ormat: null**: Interactive template pattern.
  • Gerber inspection gate: Phase 9 requires user to confirm Gerber review before delivery.
  • Non-goals explicitly exclude firmware, enclosure, and simulation — those are composable via other templates.

Checklist

  • All files have SPDX license headers
  • YAML frontmatter is valid and complete
  • manifest.yaml updated
  • Template has input/output contracts
  • Template has a quality checklist section
  • All protocol applicable_to fields updated
  • CI validation passes (\python tests/validate-manifest.py)

Add the end-to-end hardware design workflow template that orchestrates
all hardware protocols into a single interactive session. This is
Step 8 of 9 in the hardware design workflow.

The template composes 10 protocols into a 9-phase workflow:
1. Requirements discovery (requirements-elicitation)
2. Component selection (component-selection)
3. Component audit + user review (component-selection-audit)
4. Schematic design (schematic-design)
5. Schematic audit + user review (schematic-compliance-audit)
6. PCB layout & routing (pcb-layout-design)
7. Layout audit + user review (layout-design-review)
8. Manufacturing artifacts (manufacturing-artifact-generation)
9. Pre-submission review + delivery

Each phase has explicit transition rules with loop-back support:
- Phase 3 -> Phase 2 (revise components)
- Phase 5 -> Phase 4 or 2 (revise schematic or components)
- Phase 7 -> Phase 6, 4, or 2 (revise layout, schematic, or
  components — handles the schematic-layout feedback loop)
- Phase 9 -> any earlier phase if issues found

Also updates applicable_to on all 8 hardware protocols to include
hardware-design-workflow (and design-schematic where applicable).
Removes standalone composition notes from protocols that now have
template references.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Copilot AI review requested due to automatic review settings April 6, 2026 23:20
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Adds a new interactive orchestration template that composes the existing hardware design protocols into a single end-to-end workflow (requirements → components → schematic → PCB layout → manufacturing deliverables), and updates protocol metadata/manifest entries to reflect the new composition.

Changes:

  • Added hardware-design-workflow interactive template that sequences 9 phases with audit + user gates.
  • Updated applicable_to metadata on several hardware-related protocols to include hardware-design-workflow (and design-schematic where appropriate) and removed now-stale “composition note” text.
  • Registered the new template in manifest.yaml under the hardware-design category with the composed protocol list.

Reviewed changes

Copilot reviewed 9 out of 9 changed files in this pull request and generated 2 comments.

Show a summary per file
File Description
templates/hardware-design-workflow.md New capstone interactive template orchestrating the full hardware workflow across requirements, design, audit, layout, and manufacturing phases.
protocols/reasoning/component-selection.md Marks the protocol as required by design-schematic and hardware-design-workflow; removes standalone composition note.
protocols/analysis/component-selection-audit.md Marks the protocol as required by design-schematic and hardware-design-workflow; removes standalone composition note.
protocols/reasoning/schematic-design.md Marks the protocol as required by design-schematic and hardware-design-workflow; removes standalone composition note.
protocols/analysis/schematic-compliance-audit.md Adds design-schematic and hardware-design-workflow to applicable_to.
protocols/reasoning/pcb-layout-design.md Adds hardware-design-workflow to applicable_to.
protocols/analysis/layout-design-review.md Adds hardware-design-workflow to applicable_to.
protocols/reasoning/manufacturing-artifact-generation.md Adds hardware-design-workflow to applicable_to.
manifest.yaml Adds the new template entry and its composed protocol list under hardware-design.

1. requirements-elicitation protocol applicable_to was missing
   hardware-design-workflow. Added per CONTRIBUTING.md convention.

2. YAML folded block split 'pick-and-place' across lines producing
   'pick-and- place' when parsed. Rewrapped to keep compound word
   intact.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 10 out of 10 changed files in this pull request and generated 1 comment.

Phase 1 output used 'Must/Should/May' but the composed
requirements-elicitation protocol uses RFC 2119 keywords
(MUST/SHOULD/MAY) and requires acceptance criteria. Both
instructions would be active in the assembled prompt, creating
a conflict. Aligned to RFC 2119 and added acceptance criteria.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 10 out of 10 changed files in this pull request and generated no new comments.

@Alan-Jowett Alan-Jowett merged commit 5a051b1 into microsoft:main Apr 6, 2026
7 checks passed
@Alan-Jowett Alan-Jowett deleted the add-hardware-design-workflow branch April 6, 2026 23:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants