@codemcp/workflows 6.0.1 → 6.0.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (135) hide show
  1. package/package.json +3 -2
  2. package/packages/cli/package.json +1 -1
  3. package/packages/cli/resources/agents/architect.yaml +61 -0
  4. package/packages/cli/resources/agents/business-analyst.yaml +60 -0
  5. package/packages/cli/resources/agents/developer.yaml +61 -0
  6. package/packages/cli/resources/templates/architecture/arc42/arc42-template-EN.md +1077 -0
  7. package/packages/cli/resources/templates/architecture/arc42/images/01_2_iso-25010-topics-EN.drawio-2023.png +0 -0
  8. package/packages/cli/resources/templates/architecture/arc42/images/01_2_iso-25010-topics-EN.drawio.png +0 -0
  9. package/packages/cli/resources/templates/architecture/arc42/images/05_building_blocks-EN.png +0 -0
  10. package/packages/cli/resources/templates/architecture/arc42/images/08-concepts-EN.drawio.png +0 -0
  11. package/packages/cli/resources/templates/architecture/arc42/images/arc42-logo.png +0 -0
  12. package/packages/cli/resources/templates/architecture/c4.md +224 -0
  13. package/packages/cli/resources/templates/architecture/freestyle.md +53 -0
  14. package/packages/cli/resources/templates/architecture/game.md +250 -0
  15. package/packages/cli/resources/templates/architecture/none.md +17 -0
  16. package/packages/cli/resources/templates/design/comprehensive.md +207 -0
  17. package/packages/cli/resources/templates/design/freestyle.md +37 -0
  18. package/packages/cli/resources/templates/design/game.md +66 -0
  19. package/packages/cli/resources/templates/design/none.md +17 -0
  20. package/packages/cli/resources/templates/requirements/ears.md +90 -0
  21. package/packages/cli/resources/templates/requirements/freestyle.md +42 -0
  22. package/packages/cli/resources/templates/requirements/game.md +162 -0
  23. package/packages/cli/resources/templates/requirements/none.md +17 -0
  24. package/packages/cli/resources/templates/skills/POWER.md +23 -0
  25. package/packages/cli/resources/templates/skills/SKILL.md +19 -0
  26. package/packages/cli/resources/workflows/adr.yaml +157 -0
  27. package/packages/cli/resources/workflows/big-bang-conversion.yaml +592 -0
  28. package/packages/cli/resources/workflows/boundary-testing.yaml +376 -0
  29. package/packages/cli/resources/workflows/bugfix.yaml +177 -0
  30. package/packages/cli/resources/workflows/business-analysis.yaml +597 -0
  31. package/packages/cli/resources/workflows/c4-analysis.yaml +471 -0
  32. package/packages/cli/resources/workflows/epcc.yaml +183 -0
  33. package/packages/cli/resources/workflows/game-beginner.yaml +434 -0
  34. package/packages/cli/resources/workflows/greenfield.yaml +201 -0
  35. package/packages/cli/resources/workflows/minor.yaml +138 -0
  36. package/packages/cli/resources/workflows/posts.yaml +193 -0
  37. package/packages/cli/resources/workflows/sdd-bugfix-crowd.yaml +608 -0
  38. package/packages/cli/resources/workflows/sdd-bugfix.yaml +381 -0
  39. package/packages/cli/resources/workflows/sdd-feature-crowd.yaml +713 -0
  40. package/packages/cli/resources/workflows/sdd-feature.yaml +471 -0
  41. package/packages/cli/resources/workflows/sdd-greenfield-crowd.yaml +336 -0
  42. package/packages/cli/resources/workflows/sdd-greenfield.yaml +463 -0
  43. package/packages/cli/resources/workflows/slides.yaml +237 -0
  44. package/packages/cli/resources/workflows/tdd.yaml +160 -0
  45. package/packages/cli/resources/workflows/waterfall.yaml +209 -0
  46. package/packages/core/package.json +1 -1
  47. package/packages/core/resources/agents/architect.yaml +61 -0
  48. package/packages/core/resources/agents/business-analyst.yaml +60 -0
  49. package/packages/core/resources/agents/developer.yaml +61 -0
  50. package/packages/core/resources/templates/architecture/arc42/arc42-template-EN.md +1077 -0
  51. package/packages/core/resources/templates/architecture/arc42/images/01_2_iso-25010-topics-EN.drawio-2023.png +0 -0
  52. package/packages/core/resources/templates/architecture/arc42/images/01_2_iso-25010-topics-EN.drawio.png +0 -0
  53. package/packages/core/resources/templates/architecture/arc42/images/05_building_blocks-EN.png +0 -0
  54. package/packages/core/resources/templates/architecture/arc42/images/08-concepts-EN.drawio.png +0 -0
  55. package/packages/core/resources/templates/architecture/arc42/images/arc42-logo.png +0 -0
  56. package/packages/core/resources/templates/architecture/c4.md +224 -0
  57. package/packages/core/resources/templates/architecture/freestyle.md +53 -0
  58. package/packages/core/resources/templates/architecture/game.md +250 -0
  59. package/packages/core/resources/templates/architecture/none.md +17 -0
  60. package/packages/core/resources/templates/design/comprehensive.md +207 -0
  61. package/packages/core/resources/templates/design/freestyle.md +37 -0
  62. package/packages/core/resources/templates/design/game.md +66 -0
  63. package/packages/core/resources/templates/design/none.md +17 -0
  64. package/packages/core/resources/templates/requirements/ears.md +90 -0
  65. package/packages/core/resources/templates/requirements/freestyle.md +42 -0
  66. package/packages/core/resources/templates/requirements/game.md +162 -0
  67. package/packages/core/resources/templates/requirements/none.md +17 -0
  68. package/packages/core/resources/templates/skills/POWER.md +23 -0
  69. package/packages/core/resources/templates/skills/SKILL.md +19 -0
  70. package/packages/core/resources/workflows/adr.yaml +157 -0
  71. package/packages/core/resources/workflows/big-bang-conversion.yaml +592 -0
  72. package/packages/core/resources/workflows/boundary-testing.yaml +376 -0
  73. package/packages/core/resources/workflows/bugfix.yaml +177 -0
  74. package/packages/core/resources/workflows/business-analysis.yaml +597 -0
  75. package/packages/core/resources/workflows/c4-analysis.yaml +471 -0
  76. package/packages/core/resources/workflows/epcc.yaml +183 -0
  77. package/packages/core/resources/workflows/game-beginner.yaml +434 -0
  78. package/packages/core/resources/workflows/greenfield.yaml +201 -0
  79. package/packages/core/resources/workflows/minor.yaml +138 -0
  80. package/packages/core/resources/workflows/posts.yaml +193 -0
  81. package/packages/core/resources/workflows/sdd-bugfix-crowd.yaml +608 -0
  82. package/packages/core/resources/workflows/sdd-bugfix.yaml +381 -0
  83. package/packages/core/resources/workflows/sdd-feature-crowd.yaml +713 -0
  84. package/packages/core/resources/workflows/sdd-feature.yaml +471 -0
  85. package/packages/core/resources/workflows/sdd-greenfield-crowd.yaml +336 -0
  86. package/packages/core/resources/workflows/sdd-greenfield.yaml +463 -0
  87. package/packages/core/resources/workflows/slides.yaml +237 -0
  88. package/packages/core/resources/workflows/tdd.yaml +160 -0
  89. package/packages/core/resources/workflows/waterfall.yaml +209 -0
  90. package/packages/docs/package.json +1 -1
  91. package/packages/mcp-server/package.json +1 -1
  92. package/packages/mcp-server/resources/agents/architect.yaml +61 -0
  93. package/packages/mcp-server/resources/agents/business-analyst.yaml +60 -0
  94. package/packages/mcp-server/resources/agents/developer.yaml +61 -0
  95. package/packages/mcp-server/resources/templates/architecture/arc42/arc42-template-EN.md +1077 -0
  96. package/packages/mcp-server/resources/templates/architecture/arc42/images/01_2_iso-25010-topics-EN.drawio-2023.png +0 -0
  97. package/packages/mcp-server/resources/templates/architecture/arc42/images/01_2_iso-25010-topics-EN.drawio.png +0 -0
  98. package/packages/mcp-server/resources/templates/architecture/arc42/images/05_building_blocks-EN.png +0 -0
  99. package/packages/mcp-server/resources/templates/architecture/arc42/images/08-concepts-EN.drawio.png +0 -0
  100. package/packages/mcp-server/resources/templates/architecture/arc42/images/arc42-logo.png +0 -0
  101. package/packages/mcp-server/resources/templates/architecture/c4.md +224 -0
  102. package/packages/mcp-server/resources/templates/architecture/freestyle.md +53 -0
  103. package/packages/mcp-server/resources/templates/architecture/game.md +250 -0
  104. package/packages/mcp-server/resources/templates/architecture/none.md +17 -0
  105. package/packages/mcp-server/resources/templates/design/comprehensive.md +207 -0
  106. package/packages/mcp-server/resources/templates/design/freestyle.md +37 -0
  107. package/packages/mcp-server/resources/templates/design/game.md +66 -0
  108. package/packages/mcp-server/resources/templates/design/none.md +17 -0
  109. package/packages/mcp-server/resources/templates/requirements/ears.md +90 -0
  110. package/packages/mcp-server/resources/templates/requirements/freestyle.md +42 -0
  111. package/packages/mcp-server/resources/templates/requirements/game.md +162 -0
  112. package/packages/mcp-server/resources/templates/requirements/none.md +17 -0
  113. package/packages/mcp-server/resources/templates/skills/POWER.md +23 -0
  114. package/packages/mcp-server/resources/templates/skills/SKILL.md +19 -0
  115. package/packages/mcp-server/resources/workflows/adr.yaml +157 -0
  116. package/packages/mcp-server/resources/workflows/big-bang-conversion.yaml +592 -0
  117. package/packages/mcp-server/resources/workflows/boundary-testing.yaml +376 -0
  118. package/packages/mcp-server/resources/workflows/bugfix.yaml +177 -0
  119. package/packages/mcp-server/resources/workflows/business-analysis.yaml +597 -0
  120. package/packages/mcp-server/resources/workflows/c4-analysis.yaml +471 -0
  121. package/packages/mcp-server/resources/workflows/epcc.yaml +183 -0
  122. package/packages/mcp-server/resources/workflows/game-beginner.yaml +434 -0
  123. package/packages/mcp-server/resources/workflows/greenfield.yaml +201 -0
  124. package/packages/mcp-server/resources/workflows/minor.yaml +138 -0
  125. package/packages/mcp-server/resources/workflows/posts.yaml +193 -0
  126. package/packages/mcp-server/resources/workflows/sdd-bugfix-crowd.yaml +608 -0
  127. package/packages/mcp-server/resources/workflows/sdd-bugfix.yaml +381 -0
  128. package/packages/mcp-server/resources/workflows/sdd-feature-crowd.yaml +713 -0
  129. package/packages/mcp-server/resources/workflows/sdd-feature.yaml +471 -0
  130. package/packages/mcp-server/resources/workflows/sdd-greenfield-crowd.yaml +336 -0
  131. package/packages/mcp-server/resources/workflows/sdd-greenfield.yaml +463 -0
  132. package/packages/mcp-server/resources/workflows/slides.yaml +237 -0
  133. package/packages/mcp-server/resources/workflows/tdd.yaml +160 -0
  134. package/packages/mcp-server/resources/workflows/waterfall.yaml +209 -0
  135. package/packages/visualizer/package.json +1 -1
@@ -0,0 +1,207 @@
1
+ <!--
2
+ DESIGN DOCUMENT TEMPLATE - TIERED BY PROJECT COMPLEXITY
3
+
4
+ PURPOSE: Document design principles, patterns, and standards that guide implementation.
5
+ NOTE: Technology stack decisions belong in the Architecture Document, not here.
6
+
7
+ PROJECT COMPLEXITY GUIDE:
8
+ 🚀 ESSENTIAL (Startup/MVP, 1-3 developers, <6 months): Sections 1-2 only
9
+ 🏢 CORE (Small team, 2-5 developers, 6-18 months): Sections 1-4
10
+ 🏗️ ADVANCED (Enterprise, 5+ developers, 18+ months): Sections 1-5
11
+ ⚡ SPECIALIZED (Mission-critical, high reliability): All sections + custom
12
+
13
+ WHAT TO INCLUDE:
14
+ ✅ Design principles and patterns
15
+ ✅ Naming conventions and standards
16
+ ✅ Component design approaches
17
+ ✅ Data modeling principles
18
+ ✅ Quality attribute design strategies
19
+ ❌ Technology stack choices (goes in Architecture doc)
20
+ ❌ Concrete class names or implementations
21
+ ❌ Code snippets or method signatures
22
+
23
+ START SMALL: Begin with Essential sections, add more as project matures.
24
+
25
+ IMPORTANT: DO NOT REMOVE THIS COMMENT HOW TO USE THE TEMPLATE!
26
+ -->
27
+
28
+ # Design Document
29
+
30
+ <!-- # 🚀 ESSENTIAL - Required for all projects -->
31
+
32
+ ## 1. Naming Conventions
33
+
34
+ <!-- Standards for naming classes, methods, variables, constants, packages
35
+ Language-specific conventions and project-specific additions
36
+ Examples: PascalCase for classes, camelCase for methods, etc. -->
37
+
38
+ ### Classes and Types
39
+
40
+ <!-- How to name classes, interfaces, enums, type definitions -->
41
+
42
+ ### Methods and Functions
43
+
44
+ <!-- Method naming patterns, verb conventions, parameter naming -->
45
+
46
+ ### Variables and Constants
47
+
48
+ <!-- Local variables, class fields, constants, configuration values -->
49
+
50
+ ### Packages and Modules
51
+
52
+ <!-- Package/namespace organization, module naming patterns -->
53
+
54
+ ## 2. Error Handling Design
55
+
56
+ <!-- Exception hierarchy design, error propagation strategies
57
+ How errors should be categorized, handled, and communicated
58
+ Principles for graceful degradation and error recovery -->
59
+
60
+ ### Exception Design Principles
61
+
62
+ <!-- When to use checked vs unchecked exceptions, custom exception hierarchy -->
63
+
64
+ ### Error Propagation Strategy
65
+
66
+ <!-- How errors flow through system layers, error boundaries -->
67
+
68
+ ### Error Recovery Patterns
69
+
70
+ <!-- How system should behave when errors occur, fallback strategies -->
71
+
72
+ <!-- # 🏢 CORE - Recommended for professional projects -->
73
+
74
+ ## 3. Architecture Patterns & Principles
75
+
76
+ <!-- SOLID principles, DRY, KISS, YAGNI applied to this project
77
+ Which architectural patterns are preferred and why
78
+ Design pattern selection criteria and usage guidelines -->
79
+
80
+ ### Core Design Principles
81
+
82
+ <!-- How SOLID, DRY, KISS principles apply to this specific project -->
83
+
84
+ ### Preferred Architectural Patterns
85
+
86
+ <!-- Which patterns (MVC, Repository, Observer, etc.) to use when -->
87
+
88
+ ### Pattern Selection Guidelines
89
+
90
+ <!-- Criteria for choosing between different design patterns -->
91
+
92
+ ## 4. Component Design Strategy
93
+
94
+ <!-- How functionality is organized into components
95
+ Principles for component boundaries and responsibilities
96
+ Interface design and dependency management approaches -->
97
+
98
+ ### Component Boundary Principles
99
+
100
+ <!-- How to determine what belongs in each component, separation of concerns -->
101
+
102
+ ### Responsibility Assignment
103
+
104
+ <!-- How to distribute functionality across components -->
105
+
106
+ ### Interface Design Standards
107
+
108
+ <!-- How components should expose functionality, API design principles -->
109
+
110
+ ### Dependency Management
111
+
112
+ <!-- How components depend on each other, injection patterns -->
113
+
114
+ <!-- # 🏗️ ADVANCED - For complex systems and mature teams -->
115
+
116
+ ## 5. Data Design Approach
117
+
118
+ <!-- Domain modeling principles, entity design, data flow patterns
119
+ How data structures support business requirements
120
+ Consistency and integrity design strategies -->
121
+
122
+ ### Domain Modeling Principles
123
+
124
+ <!-- How to model business concepts, entity vs value object decisions -->
125
+
126
+ ### Data Transfer Patterns
127
+
128
+ <!-- DTOs, mapping between layers, data transformation strategies -->
129
+
130
+ ### Data Consistency Strategy
131
+
132
+ <!-- How to maintain data integrity, transaction boundaries -->
133
+
134
+ ### Data Access Design
135
+
136
+ <!-- Repository patterns, abstraction layers, query design -->
137
+
138
+ ## 6. Quality Attribute Implementation
139
+
140
+ <!-- How design decisions support performance, security, maintainability
141
+ Trade-off analysis and quality attribute prioritization
142
+ Specific design strategies for quality goals -->
143
+
144
+ ### Performance Design Strategy
145
+
146
+ <!-- How design choices impact performance, optimization approaches -->
147
+
148
+ ### Security Design Principles
149
+
150
+ <!-- How security requirements influence design decisions -->
151
+
152
+ ### Maintainability Design Approach
153
+
154
+ <!-- Design choices that support long-term maintenance and evolution -->
155
+
156
+ ### Scalability Design Considerations
157
+
158
+ <!-- How design supports system growth and scaling -->
159
+
160
+ <!-- # ⚡ SPECIALIZED - Add based on specific project needs -->
161
+
162
+ ## 7. Concurrency Design (If Applicable)
163
+
164
+ <!-- Thread safety principles, synchronization strategies
165
+ Asynchronous processing patterns, concurrent data access -->
166
+
167
+ ### Thread Safety Strategy
168
+
169
+ <!-- How to handle concurrent access, synchronization approaches -->
170
+
171
+ ### Asynchronous Processing Design
172
+
173
+ <!-- Promise/Future patterns, event-driven design -->
174
+
175
+ ## 8. Testing Design Philosophy (If Complex Testing Needs)
176
+
177
+ <!-- How design supports testability, test structure principles
178
+ Mocking strategies, test data management -->
179
+
180
+ ### Testability Design Principles
181
+
182
+ <!-- How to design for effective testing, dependency injection for tests -->
183
+
184
+ ### Test Structure Standards
185
+
186
+ <!-- Test organization, naming, assertion patterns -->
187
+
188
+ ## 9. Extension and Evolution Strategy (If Long-term Project)
189
+
190
+ <!-- How design accommodates future changes
191
+ Extension points, plugin architectures, versioning strategies -->
192
+
193
+ ### Design for Change Principles
194
+
195
+ <!-- How to create flexible designs that adapt to requirements -->
196
+
197
+ ### Extension Point Design
198
+
199
+ <!-- Where and how to build extensibility into the system -->
200
+
201
+ ---
202
+
203
+ # Implementation Notes
204
+
205
+ <!-- Any project-specific notes about how these design principles should be applied
206
+ Exceptions or modifications to standard patterns
207
+ Team agreements about design trade-offs -->
@@ -0,0 +1,37 @@
1
+ <!--
2
+ DESIGN DOCUMENT TEMPLATE - FREESTYLE APPROACH
3
+
4
+ PURPOSE: Document design principles and standards in your preferred format.
5
+ NOTE: Technology stack decisions belong in the Architecture Document, not here.
6
+
7
+ DESIGN FOCUS AREAS:
8
+ ✅ Design principles and patterns that guide implementation
9
+ ✅ Naming conventions and coding standards
10
+ ✅ Component design approaches and boundaries
11
+ ✅ Data modeling and design principles
12
+ ✅ Quality attribute design strategies (performance, security, etc.)
13
+ ❌ NO Technology stack choices (goes in Architecture doc)
14
+ ❌ NO Concrete class names or implementations
15
+ ❌ NO Code snippets or method signatures
16
+
17
+ TIERED APPROACH SUGGESTION:
18
+ Start with core design principles, add complexity as project grows.
19
+ Consider organizing by: Essential → Core → Advanced → Specialized sections.
20
+
21
+ EXAMPLES:
22
+ ✅ GOOD: "Repository pattern abstracts data access with clean interfaces"
23
+ ✅ GOOD: "Components follow single responsibility principle with clear boundaries"
24
+ ✅ GOOD: "Error handling uses custom exception hierarchy for different failure types"
25
+ ❌ BAD: "PaymentController.processPayment() validates and processes transactions"
26
+ ❌ BAD: "UserService extends BaseService and implements AuthService interface"
27
+
28
+ IMPORTANT: DO NOT REMOVE THIS COMMENT HOW TO USE THE TEMPLATE!
29
+ -->
30
+
31
+ # Design Document
32
+
33
+ ## Architecture Reference
34
+
35
+ See [Architecture Document](./architecture.md) for high-level system context and architecture decisions such as chosen technologies and frameworks.
36
+
37
+ <!-- Here goes your freestyle design -->
@@ -0,0 +1,66 @@
1
+ # Game Design 🛠️
2
+
3
+ **My Game**: [GAME_NAME]
4
+ **Platform**: [PLATFORM - from architecture.md]
5
+ **Date**: [DATE]
6
+
7
+ ---
8
+
9
+ ## What This Document Is For
10
+
11
+ This document explains **HOW we organize and structure** the code for building the game.
12
+
13
+ Think of it like a construction plan:
14
+
15
+ - **Requirements** = What we're building
16
+ - **Architecture** = The main parts and their jobs
17
+ - **Design** (this doc) = How to organize the construction
18
+
19
+ ---
20
+
21
+ ## Core Concepts We'll Use
22
+
23
+ <!-- LLM INSTRUCTION:
24
+ Explain the 3-4 fundamental coding patterns the child will use repeatedly.
25
+ Keep explanations simple and concrete. Use analogies.
26
+ Platform-specific examples are good.
27
+
28
+ Typical patterns:
29
+
30
+ - State (Memory) 🧠
31
+ - Mechanics (Rules) 📏
32
+ - Presentation (Drawing) 🎨
33
+ - The Game Loop 🔄
34
+
35
+ -->
36
+
37
+ ## Usage of libraries
38
+
39
+ <!--
40
+ There are many libraries providing e. g. physics or other game specific features. Based on the requirements, pick proper libraries and explain to the child what they do.
41
+ -->
42
+
43
+ ## 🗺️ How Code Is Organized
44
+
45
+ <!-- LLM INSTRUCTION:
46
+ Show the actual file/sprite structure for this specific game.
47
+ Be concrete - list actual file names or sprite names.
48
+ Explain WHAT goes in each file and WHY.
49
+
50
+ IMPORTANT:
51
+ - Maintain single responsibility principle!
52
+ - Keep it object-oriented (one building block = one file)
53
+ -->
54
+
55
+ ### File Structure for [PLATFORM]
56
+
57
+ ```
58
+ [ACTUAL_FILE_STRUCTURE]
59
+
60
+ Example for Browser/JavaScript:
61
+ game/
62
+ ├── game.js ← Game loop, manages everything
63
+ ├── player.js ← Player class (state, mechanics, drawing)
64
+ ├── enemy.js ← Enemy class
65
+ └── main.js ← Starts the game
66
+ ```
@@ -0,0 +1,17 @@
1
+ # Design Placeholder
2
+
3
+ This is a placeholder document. The user has chosen not to maintain separate design documentation for this project.
4
+
5
+ ## INSTRUCTIONS FOR LLM
6
+
7
+ **DO NOT EDIT THIS FILE**
8
+
9
+ - Use the current development plan file to specify design decisions for ongoing development
10
+ - Reference design information from the plan file context when needed
11
+ - Focus design discussion in the plan file's "Key Decisions" and implementation task sections
12
+ - When design decisions are needed, document them in the plan file rather than here
13
+ - This placeholder ensures the workflow variables work correctly while respecting the user's choice
14
+
15
+ ## User's Choice
16
+
17
+ The user has explicitly chosen not to use dedicated design documentation for this project. Please respect this decision and work with the plan file for design-related information.
@@ -0,0 +1,90 @@
1
+ <!--
2
+ INSTRUCTIONS FOR REQUIREMENTS (EARS FORMAT):
3
+ - Use EARS format
4
+ - Number requirements as REQ-1, REQ-2, etc.
5
+ - Keep user stories concise and focused on user value
6
+ - Make acceptance criteria specific and testable
7
+ - Reference requirements in tasks using: (_Requirements: REQ-1, REQ-3_)
8
+
9
+ EXAMPLE:
10
+ ## REQ-1: User Authentication
11
+ **User Story:** As a website visitor, I want to create an account so that I can access personalized features.
12
+
13
+ **Acceptance Criteria:**
14
+ - WHEN user provides valid email and password THEN the system SHALL create new account
15
+ - WHEN user provides duplicate email THEN the system SHALL show "email already exists" error
16
+ - WHEN user provides weak password THEN the system SHALL show password strength requirements
17
+
18
+ FULL EARS SYNTAX:
19
+ While <optional pre-condition>, when <optional trigger>, the <system name> shall <system response>
20
+
21
+ The EARS ruleset states that a requirement must have: Zero or many preconditions; Zero or one trigger; One system name; One or many system responses.
22
+
23
+ The application of the EARS notation produces requirements in a small number of patterns, depending on the clauses that are used. The patterns are illustrated below.
24
+
25
+ Ubiquitous requirements
26
+ Ubiquitous requirements are always active (so there is no EARS keyword)
27
+
28
+ The <system name> shall <system response>
29
+
30
+ Example: The mobile phone shall have a mass of less than XX grams.
31
+
32
+ State driven requirements
33
+ State driven requirements are active as long as the specified state remains true and are denoted by the keyword While.
34
+
35
+ While <precondition(s)>, the <system name> shall <system response>
36
+
37
+ Example: While there is no card in the ATM, the ATM shall display “insert card to begin”.
38
+
39
+ Event driven requirements
40
+ Event driven requirements specify how a system must respond when a triggering event occurs and are denoted by the keyword When.
41
+
42
+ When <trigger>, the <system name> shall <system response>
43
+
44
+ Example: When “mute” is selected, the laptop shall suppress all audio output.
45
+
46
+ Optional feature requirements
47
+ Optional feature requirements apply in products or systems that include the specified feature and are denoted by the keyword Where.
48
+
49
+ Where <feature is included>, the <system name> shall <system response>
50
+
51
+ Example: Where the car has a sunroof, the car shall have a sunroof control panel on the driver door.
52
+
53
+ Unwanted behavior requirements
54
+ Unwanted behavior requirements are used to specify the required system response to undesired situations and are denoted by the keywords If and Then.
55
+
56
+ If <trigger>, then the <system name> shall <system response>
57
+
58
+ Example: If an invalid credit card number is entered, then the website shall display “please re-enter credit card details”.
59
+
60
+ Complex requirements
61
+ The simple building blocks of the EARS patterns described above can be combined to specify requirements for richer system behavior. Requirements that include more than one EARS keyword are called Complex requirements.
62
+
63
+ While <precondition(s)>, When <trigger>, the <system name> shall <system response>
64
+
65
+ Example: While the aircraft is on ground, when reverse thrust is commanded, the engine control system shall enable reverse thrust.
66
+
67
+ Complex requirements for unwanted behavior also include the If-Then keywords.
68
+ -->
69
+
70
+ # Requirements Document
71
+
72
+ ## REQ-1: [First Requirement Title]
73
+
74
+ **User Story:** As a [user type], I want [goal] so that [benefit].
75
+
76
+ **Acceptance Criteria:**
77
+
78
+ - WHEN [condition] THEN the system SHALL [expected behavior]
79
+ - WHEN [condition] THEN the system SHALL [expected behavior]
80
+
81
+ ## REQ-2: [Second Requirement Title]
82
+
83
+ **User Story:** As a [user type], I want [goal] so that [benefit].
84
+
85
+ **Acceptance Criteria:**
86
+
87
+ - WHEN [condition] THEN the system SHALL [expected behavior]
88
+ - WHEN [condition] THEN the system SHALL [expected behavior]
89
+
90
+ <!-- Add more requirements as REQ-3, REQ-4, etc. -->
@@ -0,0 +1,42 @@
1
+ <!--
2
+ INSTRUCTIONS FOR REQUIREMENTS (FREESTYLE):
3
+ - Document user needs and system requirements in any format that works for your project
4
+ - Consider using user stories, use cases, or functional specifications
5
+ - Make requirements specific and testable
6
+ - Number or organize requirements for easy reference
7
+ - Focus on what the system should do, not how it should do it
8
+ -->
9
+
10
+ # Requirements Document
11
+
12
+ ## Functional Requirements
13
+
14
+ <!-- What the system should do -->
15
+
16
+ ### [Requirement Category]
17
+
18
+ <!-- Group related requirements together -->
19
+
20
+ ## Non-Functional Requirements
21
+
22
+ <!-- Performance, security, usability, etc. -->
23
+
24
+ ### Performance
25
+
26
+ <!-- Response times, throughput, scalability requirements -->
27
+
28
+ ### Security
29
+
30
+ <!-- Authentication, authorization, data protection requirements -->
31
+
32
+ ### Usability
33
+
34
+ <!-- User experience, accessibility requirements -->
35
+
36
+ ## Business Rules
37
+
38
+ <!-- Constraints and rules that govern system behavior -->
39
+
40
+ ## Assumptions and Dependencies
41
+
42
+ <!-- External dependencies and assumptions made -->
@@ -0,0 +1,162 @@
1
+ # My Game Plan 🎮
2
+
3
+ **My Name**: [YOUR_NAME]
4
+ **Today's Date**: [DATE]
5
+ **My Game**: [GAME_NAME]
6
+
7
+ ---
8
+
9
+ ## 🎯 Core Game Principle
10
+
11
+ <!-- LLM INSTRUCTION:
12
+ This section captures the ABSOLUTE MINIMUM game - the simplest possible version that's still fun.
13
+ Think: "What's the ONE thing that makes this game special?"
14
+ Example: For a space shooter: "Player shoots enemies that move toward them"
15
+ Example: For a platformer: "Player jumps over gaps to reach the end"
16
+ Keep it to ONE sentence that describes the core gameplay loop.
17
+ -->
18
+
19
+ **The Main Idea** (in one sentence):
20
+
21
+ [CORE_GAME_MECHANIC] - e.g., "A player dodges falling objects and collects coins"
22
+
23
+ **What Makes It Fun**:
24
+
25
+ [WHY_IS_THIS_FUN] - e.g., "It's exciting to see how long you can survive!"
26
+
27
+ **Game Type**: [e.g., Arcade, Platformer, Puzzle, Space Shooter]
28
+
29
+ ---
30
+
31
+ ## 🚀 Version 1: Let's Build This First!
32
+
33
+ <!-- LLM INSTRUCTION:
34
+ These are the MINIMUM features needed to make the core game principle playable.
35
+ Aim for 3-5 SIMPLE features. Child should be able to build this in 1-2 sessions.
36
+ Each feature should be testable and celebratable when complete.
37
+ Use simple, action-oriented language kids understand.
38
+ -->
39
+
40
+ **Goal**: Make a playable game with just the basics!
41
+
42
+ ### Must-Have Features:
43
+
44
+ **1. [FEATURE_1]** 🎮
45
+
46
+ - Example: "Player can move left and right"
47
+ - Why we need it: So you can control your character!
48
+
49
+ **2. [FEATURE_2]** 🎯
50
+
51
+ - Example: "Enemies appear at the top and move down"
52
+ - Why we need it: Something to dodge or shoot!
53
+
54
+ **3. [FEATURE_3]** ⭐
55
+
56
+ - Example: "Score goes up when you collect coins"
57
+ - Why we need it: To know how well you're doing!
58
+
59
+ **4. [FEATURE_4]** 💥
60
+
61
+ - Example: "Game over when player hits enemy"
62
+ - Why we need it: Games need a win/lose condition!
63
+
64
+ **5. [FEATURE_5]** 🔄
65
+
66
+ - Example: "Restart button to play again"
67
+ - Why we need it: So you can try to beat your score!
68
+
69
+ ### ✅ How We Know Version 1 is Done:
70
+
71
+ - [ ] I can start the game and see my character
72
+ - [ ] I can control my character with the keyboard
73
+ - [ ] [MAIN_THING] works (e.g., "Enemies appear and move")
74
+ - [ ] I can win OR lose the game
75
+ - [ ] I can play again after game over
76
+
77
+ **When Version 1 is done**: We have a REAL GAME! 🎉
78
+
79
+ **New features can be added incrementally – just start a new conversation and explain them**
80
+
81
+ ---
82
+
83
+ ## 🚧 Not Building This now (And That's OK!)
84
+
85
+ <!-- LLM INSTRUCTION:
86
+ Be explicit about what's out of scope to manage expectations.
87
+ Help child understand why some things are too complex for now.
88
+ Always end on a positive note about what they ARE building.
89
+ -->
90
+
91
+ **Things We're NOT Building** (maybe later!):
92
+
93
+ - ❌ [OUT_OF_SCOPE_1] - e.g., "Multiplayer" → Too complex! Let's master single-player first
94
+ - ❌ [OUT_OF_SCOPE_2] - e.g., "3D graphics" → 2D is perfect for learning!
95
+ - ❌ [OUT_OF_SCOPE_3] - e.g., "Mobile app" → Browser version is easier to share!
96
+
97
+ **Why not?** These would take a LONG time and lots of advanced skills. What we're building is already AWESOME! 🌟
98
+
99
+ ---
100
+
101
+ ## 📋 Our Build Order
102
+
103
+ **Phase 1**: Core Game Principle → Version 1
104
+ _"Get something playable!"_
105
+
106
+ **Phase 2**: Add Level 2 Polish
107
+ _"Make it feel great!"_
108
+
109
+ **Phase 3**: Add Level 3 Features
110
+ _"Add variety and depth!"_
111
+
112
+ ---
113
+
114
+ ## 💭 Notes & Ideas
115
+
116
+ <!-- LLM INSTRUCTION:
117
+ Use this space to capture the child's random ideas, inspirations, or decisions made during development.
118
+ Keep their creativity documented even if ideas don't fit current version.
119
+ -->
120
+
121
+ **Cool Ideas We Thought Of**:
122
+
123
+ - [IDEA_1]
124
+ - [IDEA_2]
125
+ - [IDEA_3]
126
+
127
+ **Games That Inspired Us**:
128
+
129
+ - [INSPIRATION_1]
130
+ - [INSPIRATION_2]
131
+
132
+ **Things We Learned**:
133
+
134
+ - [LEARNING_1]
135
+ - [LEARNING_2]
136
+
137
+ ---
138
+
139
+ ## 🎊 Celebration Log
140
+
141
+ <!-- LLM INSTRUCTION:
142
+ Document milestones and achievements. This builds confidence and tracks progress.
143
+ Update this as features are completed.
144
+ -->
145
+
146
+ **What We've Built So Far**:
147
+
148
+ - [ ] Version 1 Complete! (Date: **\_**) 🎉
149
+ - [ ] Level 2 Complete! (Date: **\_**) 🌟
150
+ - [ ] Level 3 Complete! (Date: **\_**) 🚀
151
+
152
+ **My Proudest Moments**:
153
+
154
+ 1. [ACHIEVEMENT_1]
155
+ 2. [ACHIEVEMENT_2]
156
+ 3. [ACHIEVEMENT_3]
157
+
158
+ ---
159
+
160
+ **Remember**: Every great game developer started exactly where you are now! 🌟
161
+
162
+ Let's build something awesome together! 🚀
@@ -0,0 +1,17 @@
1
+ # Requirements Placeholder
2
+
3
+ This is a placeholder document. The user has chosen not to maintain separate requirements documentation for this project.
4
+
5
+ ## INSTRUCTIONS FOR LLM
6
+
7
+ **DO NOT EDIT THIS FILE**
8
+
9
+ - Use the current development plan file to specify requirements for ongoing development
10
+ - Reference requirements from the plan file context when needed
11
+ - Focus requirements discussion in the plan file's "Goal" and relevant task sections
12
+ - When requirements clarification is needed, document them in the plan file rather than here
13
+ - This placeholder ensures the workflow variables work correctly while respecting the user's choice
14
+
15
+ ## User's Choice
16
+
17
+ The user has explicitly chosen not to use dedicated requirements documentation for this project. Please respect this decision and work with the plan file for requirements-related information.
@@ -0,0 +1,23 @@
1
+ ---
2
+ name: 'responsible-vibe'
3
+ displayName: 'Responsible Vibe Development Workflows'
4
+ description: >
5
+ Structured development workflows for AI-assisted coding. Provides guided
6
+ phases for feature development, bug fixing, TDD, and more.
7
+ keywords:
8
+ - 'development'
9
+ - 'workflow'
10
+ - 'feature'
11
+ - 'bug fix'
12
+ - 'TDD'
13
+ - 'test driven'
14
+ - 'refactor'
15
+ - 'planning'
16
+ - 'start development'
17
+ - 'new feature'
18
+ license: MIT
19
+ metadata:
20
+ version: '${VERSION}'
21
+ repository: https://github.com/mrsimpson/responsible-vibe-mcp
22
+ author: mrsimpson
23
+ ---
@@ -0,0 +1,19 @@
1
+ ---
2
+ name: responsible-vibe
3
+ description: >
4
+ Structured development workflows for AI-assisted coding. Use when starting
5
+ new features, fixing bugs, following TDD, refactoring code, or any development
6
+ task that benefits from planning and structure. Activate it when
7
+ users mention to build, enhance or fix code.
8
+ license: MIT
9
+ metadata:
10
+ version: '${VERSION}'
11
+ repository: https://github.com/mrsimpson/responsible-vibe-mcp
12
+ author: mrsimpson
13
+ requires-mcp-servers:
14
+ - name: workflows
15
+ package: '@codemcp/workflows-server'
16
+ description: 'Structured development workflows for AI-assisted coding'
17
+ command: npx
18
+ args: ['-y', '@codemcp/workflows-server']
19
+ ---