You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: rules/holistic-workflow.rules.md
+6-2Lines changed: 6 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,11 +1,13 @@
1
1
# Holistic Workflow: A Guide to Your Thought Process
2
+
Authored by matscode
2
3
3
4
## 1. Purpose of This Guide
4
-
This document is your "mental map." You may read the various `.rules.md` files in any order, but this guide provides the **chronological sequence** in which you should apply them. It orchestrates the individual rule sets into a single, coherent workflow, ensuring you approach every problem logically and efficiently.
5
+
This document is your "mental map." You may read the various `.rules.md` files in any order, but this guide provides the **chronological sequence** in which you should apply them. It orchestrates the individual rule sets into a single, coherent workflow, ensuring you approach every problem logically and efficiently. This workflow should be considered at all times as your primary operational guide.
5
6
6
7
This is not just a set of rules; it is a framework for your thinking.
7
8
8
9
## 2. The Recommended Workflow
10
+
Authored by matscode
9
11
10
12
### Step 1: First, Understand Who You're Working With
11
13
***Objective:** Know your user's background and communication preferences.
@@ -18,7 +20,7 @@ This is not just a set of rules; it is a framework for your thinking.
18
20
19
21
### Step 3: Third, Consult Existing Decisions
20
22
***Objective:** Avoid re-inventing the wheel and maintain consistency.
21
-
***Action:** Before creating a new solution, always check for existing architectural and design decisions.
23
+
***Action:** Before creating a new solution, you **MUST** follow the "Step 1: Specification Selection and Reuse Protocol" outlined in `rules/spec-management.rules.md`.
@@ -38,3 +40,5 @@ This is not just a set of rules; it is a framework for your thinking.
38
40
For example, if you are in the **"Implement"** step and you discover an unexpected technical challenge, you should not "push through." Instead, you should immediately return to the **"Collaborate and Clarify"** step to discuss the issue with the user and adjust the plan.
39
41
40
42
Always be ready to adapt. The goal is not to rigidly follow the steps, but to use them as a framework for intelligent, adaptive problem-solving.
43
+
44
+
-- Authored by [matscode](https://www.linkedin.com/in/matscode)
Copy file name to clipboardExpand all lines: rules/index.rules.md
+5-1Lines changed: 5 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,4 +1,5 @@
1
1
# Interactive Coding Agent: Mandatory Onboarding
2
+
Authored by matscode
2
3
3
4
## 🚨 CRITICAL: YOU MUST READ AND OBEY THESE ONBOARDING RULES FIRST
4
5
@@ -22,6 +23,7 @@ Your single, initial task is to read and understand your operational rules.
22
23
---
23
24
24
25
## 2. The Mandatory Reading Sequence
26
+
Authored by matscode
25
27
26
28
You are required to read the project's rule files in the following sequence:
27
29
@@ -43,4 +45,6 @@ This final file provides the "mental map" that connects all the other rules into
43
45
---
44
46
45
47
## 3. Onboarding Complete
46
-
Once you have completed this two-step reading process, your onboarding is complete. You may then proceed to analyze the user's request and begin your work, following the process outlined in the `holistic-workflow.rules.md`.
48
+
Once you have completed this two-step reading process, your onboarding is complete. You may then proceed to analyze the user's request and begin your work, following the process outlined in the `holistic-workflow.rules.md`.
49
+
50
+
-- Authored by [matscode](https://www.linkedin.com/in/matscode)
-**Core Rule:** You MUST always use the most up-to-date file content. Before you ask a question or implement a change, re-read any relevant files to ensure you have not missed a manual update from the user.
142
146
-**Stale Content = Critical Failure:** Basing actions on outdated information is a critical violation.
147
+
148
+
-- Authored by [matscode](https://www.linkedin.com/in/matscode)
Copy file name to clipboardExpand all lines: rules/spec-decision-examples.rules.md
+6-1Lines changed: 6 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,4 +1,5 @@
1
1
# Specification Decision Examples
2
+
Authored by [matscode](https://www.tiktok.com/@matscode)
2
3
3
4
This document provides a comprehensive, non-exhaustive list of examples for when a specification is required. It is intended as a reference to be used for validation when there is doubt.
4
5
@@ -26,6 +27,7 @@ A specification is required for **ALL** of the following:
26
27
-**Infrastructure Changes:** Deployment, CI/CD, or environment configuration modifications.
Copy file name to clipboardExpand all lines: rules/spec-management.rules.md
+15-4Lines changed: 15 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,5 +1,7 @@
1
1
# Spec Management & Referencing Rules (MANDATORY)
2
2
3
+
Authored by [matscode](https://www.tiktok.com/@matscode)
4
+
3
5
This document outlines the mandatory workflow for creating, managing, and referencing specifications. Adherence is critical for maintainability and traceability.
4
6
5
7
---
@@ -46,6 +48,9 @@ A spec is also required when coding agents need context for:
46
48
---
47
49
48
50
## 2. Agent Response Protocol
51
+
52
+
Authored by matscode
53
+
49
54
Before creating any specification file, agents MUST ask these questions to ensure optimal documentation:
50
55
51
56
**DECISION CLARITY:**
@@ -74,12 +79,12 @@ Before creating any specification file, agents MUST ask these questions to ensur
74
79
3.**Read Candidate Specifications:** Carefully examine the full content of the selected candidate specs to understand their scope and applicability.
75
80
76
81
4.**Determine Specification Strategy:** Based on your reading, choose one of the following strategies:
77
-
-**Reuse Existing:** If a spec fully covers the requirement, use it. If minor updates are needed, modify the existing spec.
78
-
-**Extend Existing:** If a spec partially covers the requirement, extend it by adding new sections. Ensure the new content is logically consistent with the existing spec.
82
+
-**Reuse Existing:** If a spec fully covers the requirement, use it. If minor updates are needed, modify the existing spec and proceed to **Step 3: Get Approval**.
83
+
-**Extend Existing:** If a spec partially covers the requirement, extend it by adding new sections. Ensure the new content is logically consistent with the existing spec, then proceed to **Step 3: Get Approval**.
79
84
-**Create Supporting Spec:** If an existing spec is related but distinct, create a new, complementary spec. Ensure a clear separation of concerns between the two.
80
85
-**Create New Spec:** Only create a new specification if no existing spec is relevant or applicable.
81
86
82
-
5.**Resolve Conflicts:** If you are uncertain which strategy to choose or which spec to update, present the options to the user and ask for guidance. Provide context for each option to help the user make an informed decision.
87
+
5.**Resolve Conflicts:** If you are uncertain which strategy to choose or which spec to update, present the options to the user and ask for guidance using an interactive command as defined in `rules/interactive-input.rules.md`. Provide context for each option to help the user make an informed decision.
83
88
84
89
### Step 2: Create
85
90
-**Location:**`project-specs/`
@@ -88,7 +93,7 @@ Before creating any specification file, agents MUST ask these questions to ensur
88
93
89
94
### Step 3: Get Approval
90
95
-**Present:** Share the spec with the user for review.
91
-
-**Ask:** Use an interactive command: `"I have created/updated the spec for [decision]. Please review and approve."`
96
+
-**Ask:** Use an interactive command as defined in `rules/interactive-input.rules.md` to ask for approval. The question should be: `"I have created/updated the spec for [decision]. Please review and approve."`
92
97
-**Wait:** Do not proceed without explicit approval.
93
98
94
99
### Step 4: Update Index
@@ -112,6 +117,8 @@ Before creating any specification file, agents MUST ask these questions to ensur
112
117
113
118
## 4. Two-Way Spec Referencing
114
119
120
+
Authored by matscode
121
+
115
122
### From Code to Spec (Mandatory)
116
123
All generated code **MUST** reference its guiding spec.
117
124
@@ -145,6 +152,8 @@ Every spec **MUST** list the code files that implement it.
145
152
146
153
## 5. Legacy Code Workflow
147
154
155
+
Authored by matscode
156
+
148
157
For existing code that lacks a spec reference, you **MUST** follow this protocol **BEFORE** making any changes:
149
158
150
159
1.**STOP & Analyze:** Do not modify the code. Analyze its functionality, dependencies, and relationship to other parts of the codebase.
@@ -163,3 +172,5 @@ For existing code that lacks a spec reference, you **MUST** follow this protocol
163
172
-**All Changes Documented:** Any change to a specification, no matter how small, **MUST** be followed by an update to the spec file and a request for user approval.
164
173
-**Your Responsibility:** Proactively identify when a new decision alters an existing spec. Update the spec and get approval before proceeding.
165
174
-**Violations:** Failure to create, reference, get approval for, or **maintain** a spec is a critical violation. Stop all work until the process is followed correctly.
175
+
176
+
-- Authored by [matscode](https://www.linkedin.com/in/matscode)
Copy file name to clipboardExpand all lines: rules/user-persona.rules.md
+14-1Lines changed: 14 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,5 +1,7 @@
1
1
# User Persona Rules
2
2
3
+
Authored by [matscode](https://www.tiktok.com/@matscode)
4
+
3
5
## 1. Core Principle: Persona-Driven Interaction
4
6
**CRITICAL REQUIREMENT:** Before any work, the agent MUST identify and load the user's persona. Proceeding without an active persona is a critical failure.
5
7
@@ -10,6 +12,9 @@
10
12
---
11
13
12
14
## 2. Persona Setup Workflow
15
+
16
+
Authored by matscode
17
+
13
18
This workflow is ONLY initiated if `specs/user-persona.spec.md` does not exist.
14
19
15
20
### Step 1: Ask for Nickname
@@ -38,6 +43,9 @@ Upon completion, save the answers (including the nickname from Step 1) to `specs
38
43
---
39
44
40
45
## 3. Communication Styles by Experience Level
46
+
47
+
Authored by matscode
48
+
41
49
You MUST adapt your communication style to match the user's experience level.
42
50
43
51
### Beginner
@@ -63,6 +71,11 @@ You MUST adapt your communication style to match the user's experience level.
63
71
---
64
72
65
73
## 4. Maintenance
74
+
75
+
Authored by matscode
76
+
66
77
If the user indicates that your communication style is not meeting their needs, you MUST:
67
78
1.**Ask for Clarification:** Inquire what level of detail they would prefer.
68
-
2.**Update the Spec:** Modify `specs/user-persona.spec.md` to reflect their new preference.
79
+
2.**Update the Spec:** Modify `specs/user-persona.spec.md` to reflect their new preference.
80
+
81
+
-- Authored by [matscode](https://www.linkedin.com/in/matscode)
0 commit comments