skills.rest
Strocs
StrocsCOMMUNITY
Explore all skills by this author →
Website𝕏@_StrocsGitHub

sdd-design

Generate a design.md documenting architecture decisions and data flow for codebase changes.

Updated Nov 19, 2024
Search Tags:#architecture#codebase#openspec#technical-design#design-doc#engram
One-click install
npx skills add https://github.com/Strocs/.dotfiles --skill sdd-design-strocs
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: sdd-design
Source: https://github.com/Strocs/.dotfiles/tree/main/.config/opencode/skills/sdd-design
Command: npx skills add https://github.com/Strocs/.dotfiles --skill sdd-design-strocs

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill unit produces a concrete technical design document that captures architecture decisions, implementation approach, data flow, file-level changes, and rationale so engineers can implement a proposed change without ambiguity.

Core Features & Use Cases

  • Design authoring: Produce a design.md that follows the project's openspec layout and documents technical approach, architecture decisions, data flow, file changes, interfaces, testing strategy, migration plan, and open questions.
  • Artifact-aware persistence: Resolve persistence modes (engram, openspec, none), retrieve proposal and spec artifacts when available, and obey the project's persistence contract for storing or returning results.
  • Codebase-informed recommendations: Read the actual repository code, patterns, and tests to produce file-specific changes and rationale that align with existing conventions.
  • Use Case: When an orchestrator asks to write or update the technical design for a feature, refactor, or bugfix, this Skill generates the design.md and a structured summary ready for downstream tasks.

Quick Start

Draft a design.md for the specified change that documents the implementation approach, architecture decisions, data flow, and concrete file changes.

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 for a codebase change?▼

To generate a technical design document, supply a change name and artifact store mode to produce a design.md capturing architecture decisions, data flow, and file-level changes for the proposed codebase modification.

What should a technical design doc include for a new feature or refactor?▼

A technical design doc should include the implementation approach, architecture decisions, data flow, file changes, interfaces, testing strategy, migration plan, and open questions to eliminate ambiguity for engineers.

How does OpenSpec handle design doc persistence and artifact storage?▼

OpenSpec handles design doc persistence by resolving storage modes like engram or openspec, retrieving proposal and spec artifacts when available, and saving the design.md in the openspec/changes/{change-name}/ directory.

Can I reference existing proposal and spec artifacts when writing a design doc?▼

Yes, you can reference existing proposal and spec artifacts when writing a design doc. The system retrieves available artifacts to align the technical design with the project's established conventions and specifications.

Do I need to read the repository code before creating a technical design document?▼

Reading repository code before creating a technical design document ensures file-specific changes and rationale align with existing code patterns and conventions, producing implementable and accurate design recommendations.

Related Skills

Explore More Software Engineering Skills→
kurojskurojs
2

sdd-design

Transform change proposals into implementation-ready technical design documents.

Community
Advanced
simonheimlichersimonheimlicher
1

architecting-python

Generate Architecture Decision Records for Python architecture decisions.

Community
Advanced
RamonsDkaRamonsDka
1

sdd-tasks

Generate phase-structured tasks.md files from design artifacts.

Community
Advanced
terceltercel
5

tech-design-generation

Generate Technical Design Documents from codebase scans and upstream requirements.

Community
Advanced