sdd-design

Generate technical design documents detailing architecture decisions, data flow, and file modifications.

Updated May 14, 2025
One-click install
npx skills add https://github.com/Mikisbell/freecloud --skill sdd-design-mikisbell
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: sdd-design
Source: https://github.com/Mikisbell/freecloud/tree/main/.agents/skills/sdd-design
Command: npx skills add https://github.com/Mikisbell/freecloud --skill sdd-design-mikisbell

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill automates the creation of technical design documents, ensuring that the 'how' of a change is clearly articulated with architecture decisions, data flow, and file impacts.

Core Features & Use Cases

  • Technical Design Generation: Creates a design.md file outlining the implementation strategy.
  • Architecture Decision Recording: Documents choices, alternatives, and rationale.
  • File Change Tracking: Lists all affected files with their modification type.
  • Use Case: When a new feature is proposed, this Skill can be invoked to draft the technical design, ensuring all stakeholders understand the implementation plan before coding begins.

Quick Start

Use the sdd-design skill to create a technical design for the 'user-authentication' 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 for software changes?

To generate a technical design document for software changes, you can use an automated skill that drafts a design.md file. It outlines the implementation strategy, detailing architecture decisions, data flow, and file impacts to ensure stakeholder clarity before coding begins.

What is included in an automated technical design document?

An automated technical design document includes the implementation strategy, architecture decision records with rationale and alternatives, data flow descriptions, and a comprehensive list of affected files with their specific modification types for full traceability.

How do I track file modifications when planning software architecture?

To track file modifications when planning software architecture, the generated design document lists all affected files alongside their modification types. This file change tracking ensures every component impacted by the proposed software change is documented.

Can I persist technical design documents using Engram or the filesystem?

Yes, you can persist technical design documents using Engram or the filesystem. The design generation process supports artifact persistence through specified modes including 'engram', 'openspec', or 'hybrid' to ensure documentation is stored and retrieved effectively.

When do I need to create an architecture decision record for a new feature?

You need to create an architecture decision record for a new feature when a change is proposed and requires documented rationale. The technical design generation process automatically records choices and alternatives to align stakeholders on the implementation plan.

What is the best way to document data flow and implementation plans before coding?

The best way to document data flow and implementation plans before coding is to generate a comprehensive technical design document. This approach automates the articulation of architecture decisions and file impacts, ensuring the 'how' of a change is clearly defined.