@schilling.mark.a/software-methodology 1.0.0
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.
- package/.github/copilot-instructions.md +106 -0
- package/LICENSE +21 -0
- package/README.md +174 -0
- package/atdd-workflow/SKILL.md +117 -0
- package/atdd-workflow/references/green-phase.md +38 -0
- package/atdd-workflow/references/red-phase.md +62 -0
- package/atdd-workflow/references/refactor-phase.md +75 -0
- package/bdd-specification/SKILL.md +88 -0
- package/bdd-specification/references/example-mapping.md +105 -0
- package/bdd-specification/references/gherkin-patterns.md +214 -0
- package/cicd-pipeline/SKILL.md +64 -0
- package/cicd-pipeline/references/deployment-rollback.md +176 -0
- package/cicd-pipeline/references/environment-promotion.md +159 -0
- package/cicd-pipeline/references/pipeline-stages.md +198 -0
- package/clean-code/SKILL.md +77 -0
- package/clean-code/references/behavioral-patterns.md +329 -0
- package/clean-code/references/creational-patterns.md +197 -0
- package/clean-code/references/enterprise-patterns.md +334 -0
- package/clean-code/references/solid.md +230 -0
- package/clean-code/references/structural-patterns.md +238 -0
- package/continuous-improvement/SKILL.md +69 -0
- package/continuous-improvement/references/measurement.md +133 -0
- package/continuous-improvement/references/process-update.md +118 -0
- package/continuous-improvement/references/root-cause-analysis.md +144 -0
- package/dist/atdd-workflow.skill +0 -0
- package/dist/bdd-specification.skill +0 -0
- package/dist/cicd-pipeline.skill +0 -0
- package/dist/clean-code.skill +0 -0
- package/dist/continuous-improvement.skill +0 -0
- package/dist/green-implementation.skill +0 -0
- package/dist/product-strategy.skill +0 -0
- package/dist/story-mapping.skill +0 -0
- package/dist/ui-design-system.skill +0 -0
- package/dist/ui-design-workflow.skill +0 -0
- package/dist/ux-design.skill +0 -0
- package/dist/ux-research.skill +0 -0
- package/docs/INTEGRATION.md +229 -0
- package/docs/QUICKSTART.md +126 -0
- package/docs/SHARING.md +828 -0
- package/docs/SKILLS.md +296 -0
- package/green-implementation/SKILL.md +155 -0
- package/green-implementation/references/angular-patterns.md +239 -0
- package/green-implementation/references/common-rejections.md +180 -0
- package/green-implementation/references/playwright-patterns.md +321 -0
- package/green-implementation/references/rxjs-patterns.md +161 -0
- package/package.json +57 -0
- package/product-strategy/SKILL.md +71 -0
- package/product-strategy/references/business-model-canvas.md +199 -0
- package/product-strategy/references/canvas-alignment.md +108 -0
- package/product-strategy/references/value-proposition-canvas.md +159 -0
- package/project-templates/context.md.template +56 -0
- package/project-templates/test-strategy.md.template +87 -0
- package/story-mapping/SKILL.md +104 -0
- package/story-mapping/references/backbone.md +66 -0
- package/story-mapping/references/release-planning.md +92 -0
- package/story-mapping/references/task-template.md +78 -0
- package/story-mapping/references/walking-skeleton.md +63 -0
- package/ui-design-system/SKILL.md +48 -0
- package/ui-design-system/references/accessibility.md +134 -0
- package/ui-design-system/references/components.md +257 -0
- package/ui-design-system/references/design-tokens.md +209 -0
- package/ui-design-system/references/layout.md +136 -0
- package/ui-design-system/references/typography.md +114 -0
- package/ui-design-workflow/SKILL.md +90 -0
- package/ui-design-workflow/references/acceptance-targets.md +144 -0
- package/ui-design-workflow/references/component-selection.md +108 -0
- package/ui-design-workflow/references/scenario-to-ui.md +151 -0
- package/ui-design-workflow/references/screen-flows.md +116 -0
- package/ux-design/SKILL.md +75 -0
- package/ux-design/references/information-architecture.md +144 -0
- package/ux-design/references/interaction-patterns.md +141 -0
- package/ux-design/references/onboarding.md +159 -0
- package/ux-design/references/usability-evaluation.md +132 -0
- package/ux-research/SKILL.md +75 -0
- package/ux-research/references/journey-mapping.md +168 -0
- package/ux-research/references/mental-models.md +106 -0
- package/ux-research/references/personas.md +102 -0
|
@@ -0,0 +1,144 @@
|
|
|
1
|
+
# Root Cause Analysis
|
|
2
|
+
|
|
3
|
+
## When to Run
|
|
4
|
+
|
|
5
|
+
Root cause analysis runs when measurement reveals a 🔴 signal, or when a defect reaches production, or when a feature required rework after screen flows were designed. It does not run for every small issue — only for outcomes that indicate a process failure, not a one-off mistake.
|
|
6
|
+
|
|
7
|
+
**Triggers:**
|
|
8
|
+
- A critical defect reached production
|
|
9
|
+
- A feature was reworked after implementation began
|
|
10
|
+
- A usability violation was discovered after shipping
|
|
11
|
+
- A measurement signal was 🔴 for two consecutive releases (pattern, not noise)
|
|
12
|
+
|
|
13
|
+
## The Core Discipline: Find the System Failure
|
|
14
|
+
|
|
15
|
+
Deming's insight is blunt: in a well-designed system, individual errors are rare. When errors are common, the system is producing them. The investigation must find where the system broke down — not where the individual broke down.
|
|
16
|
+
|
|
17
|
+
**This means the root cause is never:**
|
|
18
|
+
- "The developer made a mistake"
|
|
19
|
+
- "The designer didn't catch it"
|
|
20
|
+
- "Someone wasn't paying attention"
|
|
21
|
+
|
|
22
|
+
**The root cause is always one of:**
|
|
23
|
+
- The process did not require a check at the point where this should have been caught
|
|
24
|
+
- The process required a check but did not provide the information needed to perform it
|
|
25
|
+
- The process required a check but the check was not specific enough to catch this class of problem
|
|
26
|
+
- The process produced the right check but too late — after the cost of fixing had already grown
|
|
27
|
+
|
|
28
|
+
## The 5 Whys — Adapted for Software Process
|
|
29
|
+
|
|
30
|
+
The 5 Whys technique asks "why?" repeatedly until it reaches a systemic cause. In software process, the technique must be adapted: each "why" must land on a process step, not on a person's judgment.
|
|
31
|
+
|
|
32
|
+
### How to Apply
|
|
33
|
+
|
|
34
|
+
Start with the outcome. Ask why. If the answer is about a person ("the developer didn't test it"), reframe: what did the process require at that point, and why did the requirement not prevent this outcome?
|
|
35
|
+
|
|
36
|
+
### Example
|
|
37
|
+
|
|
38
|
+
**Outcome:** A bug shipped to production where a form accepted a negative dollar amount.
|
|
39
|
+
|
|
40
|
+
**Why did it reach production?**
|
|
41
|
+
→ No acceptance test covered negative amounts.
|
|
42
|
+
|
|
43
|
+
**Why was there no acceptance test for negative amounts?**
|
|
44
|
+
→ The acceptance targets document did not include negative amount validation as a target.
|
|
45
|
+
|
|
46
|
+
**Why was negative amount validation not in the acceptance targets?**
|
|
47
|
+
→ The screen flow did not specify validation rules for the amount field — it only specified the field exists and accepts numbers.
|
|
48
|
+
|
|
49
|
+
**Why did the screen flow not specify validation rules?**
|
|
50
|
+
→ The scenario in the feature file did not include an alternative path for invalid amounts. It only covered the happy path.
|
|
51
|
+
|
|
52
|
+
**Why did the scenario not cover invalid amounts?**
|
|
53
|
+
→ Example mapping did not surface negative amounts as an edge case. The business rule "amounts must be positive" was not listed in the rules discovered during example mapping.
|
|
54
|
+
|
|
55
|
+
**Root cause:** Example mapping did not surface the "amounts must be positive" business rule. This is a process gap — example mapping needs a prompt or checklist that explicitly asks about numeric field constraints.
|
|
56
|
+
|
|
57
|
+
**Fix:** Add "For every numeric field: what values are invalid? What is the minimum? Maximum? Can it be zero?" to the example mapping checklist in bdd-specification's example-mapping.md reference.
|
|
58
|
+
|
|
59
|
+
### The Reframing Rule
|
|
60
|
+
|
|
61
|
+
At every step, if the answer names a person, reframe:
|
|
62
|
+
|
|
63
|
+
| Person-focused answer | Reframed as process question |
|
|
64
|
+
|---|---|
|
|
65
|
+
| "Dev didn't write a test" | "What did the process require at that point, and why didn't it prevent this?" |
|
|
66
|
+
| "Designer missed it" | "What check existed to catch this, and why was it insufficient?" |
|
|
67
|
+
| "No one noticed" | "Where in the process should this have been visible, and why wasn't it?" |
|
|
68
|
+
| "It slipped through" | "What gate should have caught this, and what was missing from that gate?" |
|
|
69
|
+
|
|
70
|
+
## Depth of Investigation
|
|
71
|
+
|
|
72
|
+
Not every incident needs 5 full rounds of "why." Stop when you reach a cause that is:
|
|
73
|
+
- Systemic (affects the process, not just this instance)
|
|
74
|
+
- Actionable (can be fixed by changing a skill, a checklist, or a process step)
|
|
75
|
+
- Specific (points to exactly where in the methodology the gap exists)
|
|
76
|
+
|
|
77
|
+
If after 5 rounds you have not reached a systemic cause, the problem may be genuinely novel — something the process could not have been designed to catch. Document it as a new class of risk and add a check for it.
|
|
78
|
+
|
|
79
|
+
## Distinguishing Common Cause from Special Cause
|
|
80
|
+
|
|
81
|
+
Deming distinguished two types of variation:
|
|
82
|
+
|
|
83
|
+
**Common cause:** The system is working as designed, but the design allows this outcome. Fixing it requires changing the system. Example: "Usability violations are consistently found late" across multiple releases — the evaluation process is structurally insufficient.
|
|
84
|
+
|
|
85
|
+
**Special cause:** Something unusual happened this one time. Fixing it requires addressing the specific unusual event, not redesigning the system. Example: "A typo in a business rule caused a wrong calculation" — the rule was transcribed incorrectly once. A review step at that specific point would catch it.
|
|
86
|
+
|
|
87
|
+
**Why this matters:** Treating a common cause as a special cause (blaming the individual) changes nothing — the system will produce the same outcome again. Treating a special cause as a common cause (redesigning the system for a one-off event) adds unnecessary complexity.
|
|
88
|
+
|
|
89
|
+
**How to tell the difference:** Look at measurement history. If the same type of failure appeared in previous releases, it is common cause. If this is the first time, it is likely special cause. Act accordingly.
|
|
90
|
+
|
|
91
|
+
## Report Format
|
|
92
|
+
|
|
93
|
+
Create: `/docs/continuous-improvement/root-causes/[incident-name].md`
|
|
94
|
+
|
|
95
|
+
```markdown
|
|
96
|
+
# Root Cause Analysis: [Incident Name]
|
|
97
|
+
|
|
98
|
+
**Date discovered:** [When the problem was found]
|
|
99
|
+
**Release:** [Which release]
|
|
100
|
+
**Trigger:** [What caused this investigation — production defect, rework, measurement signal]
|
|
101
|
+
**Cause type:** Common cause / Special cause
|
|
102
|
+
|
|
103
|
+
## Outcome
|
|
104
|
+
[What happened. Specific, factual. No blame.]
|
|
105
|
+
|
|
106
|
+
## Investigation
|
|
107
|
+
|
|
108
|
+
### Why 1
|
|
109
|
+
**Question:** [Why did this outcome occur?]
|
|
110
|
+
**Answer:** [What the process produced at this point]
|
|
111
|
+
|
|
112
|
+
### Why 2
|
|
113
|
+
**Question:** [Why did the process produce that?]
|
|
114
|
+
**Answer:** [What was missing or insufficient]
|
|
115
|
+
|
|
116
|
+
### Why 3
|
|
117
|
+
[Continue until root cause is reached]
|
|
118
|
+
|
|
119
|
+
### Why 4
|
|
120
|
+
[If needed]
|
|
121
|
+
|
|
122
|
+
### Why 5
|
|
123
|
+
[If needed]
|
|
124
|
+
|
|
125
|
+
## Root Cause
|
|
126
|
+
[One clear statement of where the system failed. Points to a specific skill and a specific gap in that skill.]
|
|
127
|
+
|
|
128
|
+
## Fix
|
|
129
|
+
**Skill affected:** [Which skill needs updating]
|
|
130
|
+
**File affected:** [Which SKILL.md or reference file]
|
|
131
|
+
**Change:** [What specifically changes — add a checklist item, add a validation step, add a new signal to measurement, etc.]
|
|
132
|
+
**Applied:** [ ] Yes / [ ] No
|
|
133
|
+
|
|
134
|
+
## Validation
|
|
135
|
+
[How will we know the fix worked? What signal in the next release confirms this class of problem no longer occurs?]
|
|
136
|
+
```
|
|
137
|
+
|
|
138
|
+
## Rules
|
|
139
|
+
|
|
140
|
+
- Every production defect gets a root cause analysis. No exceptions.
|
|
141
|
+
- The investigation stops at a systemic cause, not at a person.
|
|
142
|
+
- The fix is always a change to a skill or a process step — never "be more careful."
|
|
143
|
+
- The validation section is mandatory. If you cannot define how to verify the fix worked, the fix is not specific enough.
|
|
144
|
+
- Root cause analyses are kept permanently. They are the memory of the system. When a new incident occurs, check if a previous root cause analysis covers the same class of failure — if so, the previous fix did not work and needs revisiting.
|
|
Binary file
|
|
Binary file
|
|
Binary file
|
|
Binary file
|
|
Binary file
|
|
Binary file
|
|
Binary file
|
|
Binary file
|
|
Binary file
|
|
Binary file
|
|
Binary file
|
|
Binary file
|
|
@@ -0,0 +1,229 @@
|
|
|
1
|
+
# Integration Architecture
|
|
2
|
+
|
|
3
|
+
This document explains how the software methodology integrates with different AI coding assistants.
|
|
4
|
+
|
|
5
|
+
## Multi-Tool Support
|
|
6
|
+
|
|
7
|
+
```
|
|
8
|
+
┌─────────────────────────────────────────────────────────────┐
|
|
9
|
+
│ Software Methodology Repository │
|
|
10
|
+
│ │
|
|
11
|
+
│ ┌────────────────┐ ┌────────────────┐ │
|
|
12
|
+
│ │ Skill Sources │ │ Documentation │ │
|
|
13
|
+
│ │ (Markdown) │ │ │ │
|
|
14
|
+
│ │ │ │ - SKILLS.md │ │
|
|
15
|
+
│ │ - SKILL.md │ │ - QUICKSTART │ │
|
|
16
|
+
│ │ - references/ │ │ │ │
|
|
17
|
+
│ └───────┬────────┘ └────────────────┘ │
|
|
18
|
+
│ │ │
|
|
19
|
+
│ │ Packaged into │
|
|
20
|
+
│ ▼ │
|
|
21
|
+
│ ┌────────────────┐ │
|
|
22
|
+
│ │ .skill files │ │
|
|
23
|
+
│ │ (dist/) │ │
|
|
24
|
+
│ └────────────────┘ │
|
|
25
|
+
└──────────┬──────────────────┬──────────────┬───────────────┘
|
|
26
|
+
│ │ │
|
|
27
|
+
│ │ │
|
|
28
|
+
▼ ▼ ▼
|
|
29
|
+
┌─────────────┐ ┌──────────────┐ ┌──────────────┐
|
|
30
|
+
│ Claude Code │ │ Copilot │ │ VS Code │
|
|
31
|
+
└─────────────┘ └──────────────┘ └──────────────┘
|
|
32
|
+
Uses .skill Reads .github/ Uses markdown
|
|
33
|
+
files from copilot- directly +
|
|
34
|
+
/mnt/skills/ instructions.md workspace
|
|
35
|
+
user/ settings
|
|
36
|
+
```
|
|
37
|
+
|
|
38
|
+
## File Organization
|
|
39
|
+
|
|
40
|
+
### For Claude Code
|
|
41
|
+
- **Input**: `.skill` files from `dist/` directory
|
|
42
|
+
- **Location**: `/mnt/skills/user/` on the user's system
|
|
43
|
+
- **Format**: Zipped markdown files with `.skill` extension
|
|
44
|
+
- **Workflow**: Deploy → Use skills via project `context.md`
|
|
45
|
+
|
|
46
|
+
### For GitHub Copilot
|
|
47
|
+
- **Input**: `.github/copilot-instructions.md`
|
|
48
|
+
- **Location**: Automatically read by Copilot when in the repository
|
|
49
|
+
- **Format**: Markdown with skill descriptions and guidance
|
|
50
|
+
- **Workflow**: Clone repo → Copilot reads instructions → Ask questions
|
|
51
|
+
|
|
52
|
+
### For VS Code
|
|
53
|
+
- **Input**: Markdown files + workspace configuration
|
|
54
|
+
- **Location**: `.vscode/` directory
|
|
55
|
+
- **Format**: JSON settings + multi-folder workspace
|
|
56
|
+
- **Workflow**: Open workspace → Navigate skills → Reference in code
|
|
57
|
+
|
|
58
|
+
## Integration Points
|
|
59
|
+
|
|
60
|
+
### 1. GitHub Copilot Integration
|
|
61
|
+
|
|
62
|
+
```
|
|
63
|
+
User asks question in VS Code or GitHub
|
|
64
|
+
↓
|
|
65
|
+
Copilot reads .github/copilot-instructions.md
|
|
66
|
+
↓
|
|
67
|
+
Copilot identifies relevant skill
|
|
68
|
+
↓
|
|
69
|
+
Copilot references skill's SKILL.md + references/
|
|
70
|
+
↓
|
|
71
|
+
Copilot provides context-aware guidance
|
|
72
|
+
```
|
|
73
|
+
|
|
74
|
+
**Key Files:**
|
|
75
|
+
- `.github/copilot-instructions.md` — Main instructions for Copilot
|
|
76
|
+
- `docs/SKILLS.md` — Index that Copilot can reference
|
|
77
|
+
- All `*/SKILL.md` files — Skill entry points
|
|
78
|
+
- All `*/references/*.md` — Detailed guidance
|
|
79
|
+
|
|
80
|
+
### 2. VS Code Integration
|
|
81
|
+
|
|
82
|
+
```
|
|
83
|
+
User opens workspace
|
|
84
|
+
↓
|
|
85
|
+
VS Code loads .vscode/settings.json
|
|
86
|
+
↓
|
|
87
|
+
VS Code applies markdown optimizations
|
|
88
|
+
↓
|
|
89
|
+
User navigates folders organized by skill
|
|
90
|
+
↓
|
|
91
|
+
User reads SKILL.md and references as needed
|
|
92
|
+
```
|
|
93
|
+
|
|
94
|
+
**Key Files:**
|
|
95
|
+
- `.vscode/settings.json` — VS Code editor settings
|
|
96
|
+
- `.vscode/software-methodology.code-workspace` — Multi-folder layout
|
|
97
|
+
- `docs/SKILLS.md` — Navigation index
|
|
98
|
+
- `docs/QUICKSTART.md` — Getting started guide
|
|
99
|
+
|
|
100
|
+
### 3. Claude Code Integration (Unchanged)
|
|
101
|
+
|
|
102
|
+
```
|
|
103
|
+
User deploys .skill files to /mnt/skills/user/
|
|
104
|
+
↓
|
|
105
|
+
User creates context.md in project
|
|
106
|
+
↓
|
|
107
|
+
Claude Code reads context.md at session start
|
|
108
|
+
↓
|
|
109
|
+
Claude Code loads relevant skills on demand
|
|
110
|
+
↓
|
|
111
|
+
Skills access their SKILL.md + references/
|
|
112
|
+
```
|
|
113
|
+
|
|
114
|
+
**Key Files:**
|
|
115
|
+
- `dist/*.skill` — Packaged skill files
|
|
116
|
+
- `project-templates/context.md.template` — Project setup
|
|
117
|
+
- `project-templates/test-strategy.md.template` — Test configuration
|
|
118
|
+
|
|
119
|
+
## Content Flow
|
|
120
|
+
|
|
121
|
+
### Source → Multiple Outputs
|
|
122
|
+
|
|
123
|
+
```
|
|
124
|
+
Skill Source (e.g., clean-code/)
|
|
125
|
+
│
|
|
126
|
+
├── SKILL.md (75 lines, routing logic)
|
|
127
|
+
│ └── When to use, what it does, decision tree
|
|
128
|
+
│
|
|
129
|
+
└── references/
|
|
130
|
+
├── solid.md
|
|
131
|
+
├── structural-patterns.md
|
|
132
|
+
├── behavioral-patterns.md
|
|
133
|
+
└── ...
|
|
134
|
+
|
|
135
|
+
↓
|
|
136
|
+
|
|
137
|
+
Packaged into
|
|
138
|
+
|
|
139
|
+
↓
|
|
140
|
+
|
|
141
|
+
┌──────────────────┬──────────────────┬──────────────────┐
|
|
142
|
+
│ │ │ │
|
|
143
|
+
▼ ▼ ▼ ▼
|
|
144
|
+
dist/ .github/ .vscode/ docs/
|
|
145
|
+
clean-code.skill copilot- settings.json SKILLS.md
|
|
146
|
+
(for Claude) instructions.md workspace (index)
|
|
147
|
+
(references (navigation)
|
|
148
|
+
clean-code)
|
|
149
|
+
```
|
|
150
|
+
|
|
151
|
+
### No Duplication
|
|
152
|
+
|
|
153
|
+
- **Skill sources** remain the single source of truth
|
|
154
|
+
- **Claude Code** reads from packaged `.skill` files
|
|
155
|
+
- **Copilot** reads instructions that *reference* the sources
|
|
156
|
+
- **VS Code** navigates the markdown sources directly
|
|
157
|
+
- **No content is duplicated** — only packaging differs
|
|
158
|
+
|
|
159
|
+
## Benefits of This Architecture
|
|
160
|
+
|
|
161
|
+
### 1. **Single Source of Truth**
|
|
162
|
+
All skill content lives in the skill directories. Updates to SKILL.md or references/ automatically benefit all tools.
|
|
163
|
+
|
|
164
|
+
### 2. **Tool Flexibility**
|
|
165
|
+
Users can choose:
|
|
166
|
+
- Claude Code for interactive skill execution
|
|
167
|
+
- GitHub Copilot for inline code suggestions and chat
|
|
168
|
+
- VS Code for manual reference and navigation
|
|
169
|
+
- Any combination of the above
|
|
170
|
+
|
|
171
|
+
### 3. **No Lock-in**
|
|
172
|
+
The methodology is defined in markdown. If a new AI tool emerges, we can add integration without changing the skills.
|
|
173
|
+
|
|
174
|
+
### 4. **Backward Compatible**
|
|
175
|
+
Existing Claude Code users see no changes. The `.skill` files in `dist/` remain unchanged.
|
|
176
|
+
|
|
177
|
+
### 5. **Forward Compatible**
|
|
178
|
+
New skills added to the repository automatically work with all tools.
|
|
179
|
+
|
|
180
|
+
## Usage Patterns
|
|
181
|
+
|
|
182
|
+
### Pattern 1: Copilot for Coding, Claude for Strategy
|
|
183
|
+
- Use GitHub Copilot in VS Code for day-to-day coding with inline suggestions
|
|
184
|
+
- Use Claude Code for strategic work (creating canvases, story mapping, etc.)
|
|
185
|
+
- Both reference the same methodology
|
|
186
|
+
|
|
187
|
+
### Pattern 2: Pure Copilot
|
|
188
|
+
- Clone the methodology repository as a submodule
|
|
189
|
+
- Let Copilot guide you through the skills
|
|
190
|
+
- Manually create deliverables (canvases, personas, etc.)
|
|
191
|
+
- Reference skill markdown files as needed
|
|
192
|
+
|
|
193
|
+
### Pattern 3: Pure Claude Code
|
|
194
|
+
- Deploy `.skill` files to `/mnt/skills/user/`
|
|
195
|
+
- Use Claude Code for the entire workflow
|
|
196
|
+
- Claude executes skills and creates deliverables
|
|
197
|
+
- Ignore the Copilot/VS Code integration files
|
|
198
|
+
|
|
199
|
+
### Pattern 4: VS Code Reference
|
|
200
|
+
- Open the methodology workspace in VS Code
|
|
201
|
+
- Use it as a reference manual
|
|
202
|
+
- Navigate between skills and patterns
|
|
203
|
+
- Copy templates and patterns into your code
|
|
204
|
+
|
|
205
|
+
## Maintenance
|
|
206
|
+
|
|
207
|
+
When updating a skill:
|
|
208
|
+
|
|
209
|
+
1. **Edit the source** in the skill directory (e.g., `clean-code/SKILL.md`)
|
|
210
|
+
2. **Repackage for Claude** (if needed):
|
|
211
|
+
```bash
|
|
212
|
+
python3 /mnt/skills/examples/skill-creator/scripts/package_skill.py clean-code/ dist/
|
|
213
|
+
```
|
|
214
|
+
3. **Copilot and VS Code automatically see the changes** — no additional steps needed
|
|
215
|
+
|
|
216
|
+
The integration requires no special maintenance. The documentation files (copilot-instructions.md, SKILLS.md) only need updates when:
|
|
217
|
+
- Adding a new skill to the methodology
|
|
218
|
+
- Changing the methodology flow/chain
|
|
219
|
+
- Adding new integration patterns
|
|
220
|
+
|
|
221
|
+
## Summary
|
|
222
|
+
|
|
223
|
+
This architecture provides maximum flexibility:
|
|
224
|
+
- **Write once** in markdown
|
|
225
|
+
- **Package once** for Claude Code
|
|
226
|
+
- **Reference anywhere** with Copilot and VS Code
|
|
227
|
+
- **No duplication** of content
|
|
228
|
+
- **No lock-in** to any single tool
|
|
229
|
+
- **Backward compatible** with existing workflows
|
|
@@ -0,0 +1,126 @@
|
|
|
1
|
+
# Quick Start Guide
|
|
2
|
+
|
|
3
|
+
Choose your AI coding assistant and get started with the software methodology.
|
|
4
|
+
|
|
5
|
+
## For GitHub Copilot Users
|
|
6
|
+
|
|
7
|
+
### In VS Code
|
|
8
|
+
|
|
9
|
+
1. **Install GitHub Copilot extensions:**
|
|
10
|
+
- GitHub Copilot
|
|
11
|
+
- GitHub Copilot Chat
|
|
12
|
+
|
|
13
|
+
2. **Clone or reference this repository:**
|
|
14
|
+
```bash
|
|
15
|
+
# Add as submodule to your project
|
|
16
|
+
git submodule add https://github.com/MarkSchilling/software-methodology.git methodology
|
|
17
|
+
|
|
18
|
+
# Or clone separately
|
|
19
|
+
git clone https://github.com/MarkSchilling/software-methodology.git
|
|
20
|
+
```
|
|
21
|
+
|
|
22
|
+
3. **Open the workspace (optional but recommended):**
|
|
23
|
+
```bash
|
|
24
|
+
code methodology/.vscode/software-methodology.code-workspace
|
|
25
|
+
```
|
|
26
|
+
|
|
27
|
+
4. **Ask Copilot for guidance:**
|
|
28
|
+
- "Which methodology skill should I use for writing acceptance tests?"
|
|
29
|
+
- "Show me the ATDD workflow"
|
|
30
|
+
- "What clean code patterns apply here?"
|
|
31
|
+
|
|
32
|
+
### In GitHub (Copilot Chat)
|
|
33
|
+
|
|
34
|
+
Copilot automatically reads `.github/copilot-instructions.md` when you:
|
|
35
|
+
- Ask questions in pull requests
|
|
36
|
+
- Use Copilot Chat in discussions
|
|
37
|
+
- Request code suggestions
|
|
38
|
+
|
|
39
|
+
Example questions:
|
|
40
|
+
- "How should I structure this feature based on the methodology?"
|
|
41
|
+
- "What's the next step in the chain after BDD specification?"
|
|
42
|
+
- "Which design pattern should I use here?"
|
|
43
|
+
|
|
44
|
+
## For Claude Code Users
|
|
45
|
+
|
|
46
|
+
1. **Copy skill files to your project:**
|
|
47
|
+
```bash
|
|
48
|
+
cp dist/*.skill /mnt/skills/user/
|
|
49
|
+
```
|
|
50
|
+
|
|
51
|
+
2. **Create project context files:**
|
|
52
|
+
```bash
|
|
53
|
+
cp project-templates/context.md.template your-project/docs/context.md
|
|
54
|
+
cp project-templates/test-strategy.md.template your-project/docs/test-strategy.md
|
|
55
|
+
```
|
|
56
|
+
|
|
57
|
+
3. **Fill in project details** in `context.md` and `test-strategy.md`
|
|
58
|
+
|
|
59
|
+
4. **Start with product-strategy:**
|
|
60
|
+
Ask Claude to create the Business Model Canvas and Value Proposition Canvas.
|
|
61
|
+
|
|
62
|
+
5. **Follow the chain:**
|
|
63
|
+
Each skill's `SKILL.md` tells you the prerequisites and next steps.
|
|
64
|
+
|
|
65
|
+
## Core Concepts
|
|
66
|
+
|
|
67
|
+
### The Methodology Chain
|
|
68
|
+
|
|
69
|
+
```
|
|
70
|
+
product-strategy → ux-research → story-mapping → bdd-specification →
|
|
71
|
+
ux-design → ui-design-workflow → atdd-workflow → cicd-pipeline →
|
|
72
|
+
continuous-improvement (feeds back)
|
|
73
|
+
```
|
|
74
|
+
|
|
75
|
+
### Reference Skills (Consulted During Other Steps)
|
|
76
|
+
|
|
77
|
+
- **ui-design-system** — Used during `ui-design-workflow`
|
|
78
|
+
- **clean-code** — Used during `atdd-workflow` GREEN and REFACTOR phases
|
|
79
|
+
|
|
80
|
+
### Key Deliverables by Skill
|
|
81
|
+
|
|
82
|
+
| Skill | Creates |
|
|
83
|
+
|-------|---------|
|
|
84
|
+
| product-strategy | Business Model Canvas, Value Proposition Canvas |
|
|
85
|
+
| ux-research | Personas, Mental Models, User Journey Maps |
|
|
86
|
+
| story-mapping | Backbone, Release Plans |
|
|
87
|
+
| bdd-specification | Feature Files (Gherkin) |
|
|
88
|
+
| ux-design | Information Architecture, Interaction Patterns |
|
|
89
|
+
| ui-design-workflow | Screen Flows, Component Selections |
|
|
90
|
+
| atdd-workflow | Implementation (tests + code) |
|
|
91
|
+
| cicd-pipeline | Pipeline Configuration, Deployment Scripts |
|
|
92
|
+
| continuous-improvement | Metrics, Root Cause Analysis, Process Improvements |
|
|
93
|
+
|
|
94
|
+
## Navigation
|
|
95
|
+
|
|
96
|
+
- **Full Skills Index**: See [`SKILLS.md`](SKILLS.md) for detailed information about each skill
|
|
97
|
+
- **Sharing Guide**: See [`SHARING.md`](SHARING.md) for how to share with teams and organizations
|
|
98
|
+
- **Project Templates**: Check [`../project-templates/`](../project-templates/) for starter files
|
|
99
|
+
- **Main README**: See [`../README.md`](../README.md) for repository overview
|
|
100
|
+
|
|
101
|
+
## Common Questions
|
|
102
|
+
|
|
103
|
+
**Q: Do I need to use all 11 skills?**
|
|
104
|
+
A: Start with the ones relevant to your current phase. At minimum, create the Business Model Canvas and Value Proposition Canvas first — other skills depend on them.
|
|
105
|
+
|
|
106
|
+
**Q: Can I use multiple AI assistants?**
|
|
107
|
+
A: Yes! The skills work with both Claude Code and GitHub Copilot. Use whichever fits your workflow.
|
|
108
|
+
|
|
109
|
+
**Q: How do I know which skill to use?**
|
|
110
|
+
A: Ask your AI assistant, or check the [Skills Index](SKILLS.md) for a description of each skill's purpose and when to use it.
|
|
111
|
+
|
|
112
|
+
**Q: Are the skills mandatory in order?**
|
|
113
|
+
A: For new products, yes — follow the chain. For existing products, jump to the relevant skill based on what you're working on.
|
|
114
|
+
|
|
115
|
+
**Q: Can I customize the skills?**
|
|
116
|
+
A: Yes! Edit the source files in each skill directory, then repackage for Claude Code if needed. See the main README for details.
|
|
117
|
+
|
|
118
|
+
**Q: How can I share these skills with my team?**
|
|
119
|
+
A: See the [Sharing Guide](SHARING.md) for multiple distribution options including forking the repo, creating packages, or using direct downloads.
|
|
120
|
+
|
|
121
|
+
## Getting Help
|
|
122
|
+
|
|
123
|
+
- **Skills Index**: [`SKILLS.md`](SKILLS.md)
|
|
124
|
+
- **Sharing Guide**: [`SHARING.md`](SHARING.md)
|
|
125
|
+
- **Repository**: [github.com/MarkSchilling/software-methodology](https://github.com/MarkSchilling/software-methodology)
|
|
126
|
+
- **Issues**: Report problems or suggestions via GitHub Issues
|