SoftwareDesignDocumentTask
Generates comprehensive software design documentation including Mermaid diagrams, requirements specifications, architectural blueprints, and structured project planning data (JSON) for immediate execution.
Side-Effect Safe
GPT-4 Preferred
Mermaid Supported
⚙️ SoftwareDesignDocumentTaskExecutionConfigData
{
"project_name": "Nexus API Gateway",
"system_description": "A high-performance
edge gateway with auth and rate limiting.",
"target_audience": "Enterprise Developers",
"generate_architecture": true,
"generate_project_data": true,
"sprint_count": 4,
"technology_stack": ["Kotlin", "Ktor", "Redis"]
}→
👁️ Session UI (Overview Tab)
Generation Progress
✅ Use Cases & Actors
✅ Requirements Specification
🔄 Architecture Diagrams
⏳ Project Data JSON
[Mermaid: C4 Container Diagram]
Client -> [API Gateway] -> [Microservices]
Live Results Showcase
Explore actual artifacts generated by this task, including the project_data.json and Mermaid-enhanced Markdown reports.
| Field | Type | Description |
|---|---|---|
project_name* |
String | The name/title of the software project. |
system_description* |
String | High-level description of the software system to design. |
target_audience |
String | Primary users (e.g., 'enterprise users', 'mobile consumers'). |
stakeholders |
List<String> | Key stakeholders and their roles. |
generate_architecture |
Boolean | Generate C4, component, and deployment diagrams. Default: true. |
generate_project_data |
Boolean | Output project data JSON with tasks, epics, and sprints. Default: true. |
sprint_count |
Int | Number of sprints to plan. Default: 6. |
sprint_duration_weeks |
Int | Duration of each sprint. Default: 2. |
technology_stack |
List<String> | Constraints or preferences (e.g., ["Kotlin", "AWS"]). |
input_files |
List<String> | Glob patterns for source files to use as context. |
generate_test_plan |
Boolean | Generate test strategy and case documentation. Default: true. |