skills.rest
KilloconQ
KilloconQCOMMUNITY
Explore all skills by this author →
WebsiteGitHub

sdd-design

Draft technical design documents from change proposals into openspec/changes/{change-name}/design.md.

Updated Jun 22, 2024
Search Tags:#design#architecture#documentation#openspec#technical-design#design-doc#change-management
One-click install
npx skills add https://github.com/KilloconQ/dotfiles --skill sdd-design-killoconq
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: sdd-design
Source: https://github.com/KilloconQ/dotfiles/tree/main/opencode/.config/opencode/skills/sdd-design
Command: npx skills add https://github.com/KilloconQ/dotfiles --skill sdd-design-killoconq

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Create clear, implementable technical designs from change proposals, reducing ambiguity and rework.

Core Features & Use Cases

  • Generate a formal design document (design.md) that details architecture decisions, data flow, file changes, and technical rationale.
  • Integrate with openspec conventions by placing the document at openspec/changes/{change-name}/design.md and referencing proposal.md and specs as dependencies.
  • Provide a structured, review-friendly artifact suitable for engineering teams and reviewers.

Quick Start

Provide the change name along with its proposal and specs to generate the design document at openspec/changes/{change-name}/design.md.

Frequently Asked Questions about sdd-design

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

FAQPage Schema
How do I generate a technical design document from a change proposal?▼

To generate a technical design document, provide the change name alongside its proposal and specifications. The system drafts architecture decisions, data flow, and implementation plans into a structured design doc.

What is the openspec convention for structuring technical design files?▼

The openspec convention requires placing technical design files at openspec/changes/{change-name}/design.md. This format standardizes architecture decisions and implementation plans for engineering review.

Can I use this to document architecture decisions and data-flow diagrams for software changes?▼

Yes, you can document architecture decisions and data-flow diagrams for software changes. The system produces a formal design.md detailing file changes, technical rationale, and implementation plans.

What do I need to provide to start drafting design docs for software architecture?▼

You need to provide the change name, the proposal.md, and the relevant specifications. These inputs are used to generate the structured design document at the specified openspec path.

Does this approach integrate proposal.md and specs as dependencies for the design doc?▼

Yes, this approach integrates proposal.md and specs as dependencies. The generated design document references these files to provide a structured, review-friendly artifact for engineering teams.

When do I need a formal design document for change management?▼

You need a formal design document when software changes require architecture decisions, data-flow diagrams, and implementation plans. This reduces ambiguity and rework by producing a review-friendly artifact.

Related Skills

Explore More Software Engineering Skills→
CodenburgCodenburg

sdd-design

Generate technical design documents from proposals and specifications.

Community
Advanced
JNZaderJNZader

sdd-design

Generate a design.md documenting architecture decisions, data flow, and rationale.

Community
Advanced
HeartcoolmanHeartcoolman
88

openspec-propose

Generate design, specification, and task proposals via the openspec CLI.

Community
Advanced
dha201dha201

architecture-documentation

Generate technical architecture documentation with C4 diagrams from codebases.

Community
Advanced