sdd-design

Generate a design.md with architecture decisions, data flow, and file changes.

3|Updated Apr 5, 2023
One-click install
npx skills add https://github.com/mrp4sten/.dotfiles --skill sdd-design-mrp4sten
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: sdd-design
Source: https://github.com/mrp4sten/.dotfiles/tree/main/development/IA/opencode/skill/sdd-design
Command: npx skills add https://github.com/mrp4sten/.dotfiles --skill sdd-design-mrp4sten

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This design unit translates a change proposal into a structured technical design document, capturing architecture decisions and rationale to guide implementation.

Core Features & Use Cases

  • Generate a comprehensive design.md from a proposal, specs, and code context.
  • Document architecture diagrams, data flow, interfaces, and file changes for clear developer guidance.
  • Facilitate alignment with project conventions and enable traceable design decisions.

Quick Start

Provide a complete design.md detailing architecture decisions, data flow, file changes, and technical rationale for the given change.

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?▼

Generating a technical design document involves reading the change proposal, specs, and existing code patterns to output a design.md with architecture decisions, data flow, interfaces, and migration steps.

What should be included in a software design doc for architecture changes?▼

A software design doc for architecture changes must capture data flow, interfaces, file changes, migration steps, testing strategy, and open questions to provide clear, actionable developer guidance.

How do I ensure my design document aligns with existing codebase conventions?▼

Aligning a design document with codebase conventions requires analyzing existing code patterns and specs to ensure the proposed architecture decisions and data flow match established project standards.

Can I document data flow and migration steps automatically in a design doc?▼

Documenting data flow and migration steps happens automatically when translating a proposal into a design.md, which captures the precise data flow, interfaces, and migration steps required.

What is the best way to translate software specs into actionable file changes?▼

Translating software specs into actionable file changes involves generating a design doc that maps the technical rationale and architecture decisions to precise file paths and testing strategies.

When do I need a formal design document for codebase changes?▼

A formal design document is needed for codebase changes when translating a proposal requires documenting architecture decisions, data flow, and technical rationale to guide implementation and enable traceability.