design-consult

Produce a design plan for placing new code within existing architecture.

Updated Jan 5, 2025
One-click install
npx skills add https://github.com/pkuppens/pkuppens --skill design-consult
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: design-consult
Source: https://github.com/pkuppens/pkuppens/tree/main/skills/design/design-consult
Command: npx skills add https://github.com/pkuppens/pkuppens --skill design-consult

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Consults current design and architecture to place new code correctly within existing components, interfaces, and data flows. Use after architecture-consult, before implementation-construction; ensures single responsibility and correct layering.

Core Features & Use Cases

  • Map where new code fits within existing components, interfaces, and data flows; focus on detailed placement rather than high-level modules.
  • Check interfaces and abstractions for compatibility; identify extension points like factories, registries, or plugin patterns.
  • Decide between extending existing abstractions or creating new ones; ensure single responsibility.
  • Define method signatures and public API early to guide implementation.

Quick Start

Review the target module, identify interfaces, and draft the public API before implementation.

Frequently Asked Questions about design-consult

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

FAQPage Schema
How do I determine where to place new code in an existing software architecture?

Extension points such as factories, registries, or plugin patterns are identified by checking existing interfaces and abstractions for compatibility. This helps you decide whether to extend an existing abstraction or create a new one.

When should I define method signatures and public API during the design process?

You should define method signatures and the public API early in the design process, right after high-level architecture is set and before implementation construction. This drafts the design plan and guides the subsequent coding work.

What is the best way to ensure single responsibility when adding new features?

The best way to ensure single responsibility when adding features is to consult your current design and architecture. This maps the new code within existing data flows and components to verify proper layering and correct placement.

Can I use design layering to decide between extending existing abstractions or creating new ones?

Yes, design layering helps you decide between extending existing abstractions or creating new ones by checking interface compatibility. It produces a design plan detailing extension points, new file design, and naming conventions.