@devobsessed/code-captain 0.1.0 → 0.2.1
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/README.md +1 -1
- package/bin/install.js +48 -18
- package/claude-code/commands/cc-create-spec.md +627 -0
- package/copilot/README.md +27 -27
- package/copilot/{chatmodes/Code Captain.chatmode.md → agents/Code Captain.agent.md } +16 -18
- package/copilot/copilot-instructions.md +64 -0
- package/copilot/prompts/create-adr.prompt.md +18 -106
- package/copilot/prompts/create-spec.prompt.md +26 -113
- package/copilot/prompts/edit-spec.prompt.md +11 -180
- package/copilot/prompts/execute-task.prompt.md +7 -22
- package/copilot/prompts/explain-code.prompt.md +14 -139
- package/copilot/prompts/initialize.prompt.md +9 -12
- package/copilot/prompts/new-command.prompt.md +25 -213
- package/copilot/prompts/plan-product.prompt.md +15 -306
- package/copilot/prompts/research.prompt.md +12 -139
- package/copilot/prompts/status.prompt.md +37 -365
- package/copilot/prompts/swab.prompt.md +9 -135
- package/manifest.json +123 -107
- package/package.json +1 -1
package/copilot/README.md
CHANGED
|
@@ -1,8 +1,8 @@
|
|
|
1
1
|
# Code Captain for GitHub Copilot + VS Code
|
|
2
2
|
|
|
3
|
-
> **Classic VS Code with AI-powered
|
|
3
|
+
> **Classic VS Code with AI-powered agents and prompts**
|
|
4
4
|
|
|
5
|
-
Transform GitHub Copilot Chat into a structured development workflow system with custom
|
|
5
|
+
Transform GitHub Copilot Chat into a structured development workflow system with custom agents, prompts, and organized documentation.
|
|
6
6
|
|
|
7
7
|
## 🚀 Installation
|
|
8
8
|
|
|
@@ -13,7 +13,7 @@ npx @devobsessed/code-captain
|
|
|
13
13
|
```
|
|
14
14
|
|
|
15
15
|
The installer will detect VS Code with Copilot and install to:
|
|
16
|
-
- `.github/
|
|
16
|
+
- `.github/agents/` - Code Captain agent
|
|
17
17
|
- `.github/prompts/` - Workflow prompt templates
|
|
18
18
|
- `.code-captain/` - Complete workflow system
|
|
19
19
|
|
|
@@ -21,16 +21,16 @@ The installer will detect VS Code with Copilot and install to:
|
|
|
21
21
|
|
|
22
22
|
```bash
|
|
23
23
|
# Clone or download the copilot/ directory contents to .github/
|
|
24
|
-
cp -r copilot/
|
|
24
|
+
cp -r copilot/agents/ .github/agents/
|
|
25
25
|
cp -r copilot/prompts/ .github/prompts/
|
|
26
26
|
cp -r .code-captain/ .
|
|
27
27
|
```
|
|
28
28
|
|
|
29
29
|
## 🎯 Command Syntax
|
|
30
30
|
|
|
31
|
-
Code Captain integrates with Copilot Chat through a custom
|
|
31
|
+
Code Captain integrates with Copilot Chat through a custom agent. After installation:
|
|
32
32
|
|
|
33
|
-
1. **Select Code Captain
|
|
33
|
+
1. **Select Code Captain agent** from the agent picker
|
|
34
34
|
2. **Use slash commands** directly:
|
|
35
35
|
|
|
36
36
|
```bash
|
|
@@ -40,12 +40,12 @@ Code Captain integrates with Copilot Chat through a custom chat mode. After inst
|
|
|
40
40
|
/status
|
|
41
41
|
```
|
|
42
42
|
|
|
43
|
-
## 📁
|
|
43
|
+
## 📁 Agents & Prompts
|
|
44
44
|
|
|
45
|
-
###
|
|
46
|
-
Located in `.github/
|
|
45
|
+
### Agent
|
|
46
|
+
Located in `.github/agents/`:
|
|
47
47
|
|
|
48
|
-
- **Code Captain.
|
|
48
|
+
- **Code Captain.agent.md** - Automatically available in agent picker
|
|
49
49
|
|
|
50
50
|
### Available Prompts
|
|
51
51
|
Located in `.github/prompts/`:
|
|
@@ -66,7 +66,7 @@ Located in `.github/prompts/`:
|
|
|
66
66
|
|
|
67
67
|
### 📋 Analysis & Research
|
|
68
68
|
- **Research Topics**: AI/ML frameworks, database patterns, security approaches
|
|
69
|
-
- **Market Analysis**: Competitive landscapes, feature comparisons
|
|
69
|
+
- **Market Analysis**: Competitive landscapes, feature comparisons
|
|
70
70
|
- **Technical Evaluation**: Library assessments, architecture reviews
|
|
71
71
|
|
|
72
72
|
### ⚙️ Implementation
|
|
@@ -78,7 +78,7 @@ Located in `.github/prompts/`:
|
|
|
78
78
|
|
|
79
79
|
### Phase 1: Enhanced Core Features ✅
|
|
80
80
|
1. **Advanced Analysis** - Multi-language support, framework detection
|
|
81
|
-
2. **Rich Specifications** - Visual diagrams, interaction flows, API schemas
|
|
81
|
+
2. **Rich Specifications** - Visual diagrams, interaction flows, API schemas
|
|
82
82
|
3. **Smart Implementation** - Context-aware code generation, test automation
|
|
83
83
|
|
|
84
84
|
### Phase 2: Quality & Collaboration 🚧
|
|
@@ -93,10 +93,10 @@ Located in `.github/prompts/`:
|
|
|
93
93
|
|
|
94
94
|
## 🔄 Workflow Examples
|
|
95
95
|
|
|
96
|
-
### Using the
|
|
96
|
+
### Using the Agent
|
|
97
97
|
|
|
98
98
|
1. **Open Copilot Chat** in VS Code
|
|
99
|
-
2. **Select "Code Captain"** from the
|
|
99
|
+
2. **Select "Code Captain"** from the agent picker
|
|
100
100
|
3. **Type:** `/initialize`
|
|
101
101
|
4. **Follow the prompts** for project analysis
|
|
102
102
|
5. **Review generated files** in `.code-captain/docs/`
|
|
@@ -111,7 +111,7 @@ Located in `.github/prompts/`:
|
|
|
111
111
|
### Complete Feature Development
|
|
112
112
|
|
|
113
113
|
```bash
|
|
114
|
-
# Select "Code Captain"
|
|
114
|
+
# Select "Code Captain" agent, then:
|
|
115
115
|
|
|
116
116
|
# 1. Project setup
|
|
117
117
|
/initialize
|
|
@@ -138,8 +138,8 @@ Copilot integration creates this structure:
|
|
|
138
138
|
|
|
139
139
|
```
|
|
140
140
|
.github/
|
|
141
|
-
├──
|
|
142
|
-
│ └── Code Captain.
|
|
141
|
+
├── agents/
|
|
142
|
+
│ └── Code Captain.agent.md
|
|
143
143
|
└── prompts/
|
|
144
144
|
├── create-spec.prompt.md
|
|
145
145
|
├── create-adr.prompt.md
|
|
@@ -163,8 +163,8 @@ Copilot integration creates this structure:
|
|
|
163
163
|
|
|
164
164
|
## 🎯 Copilot-Specific Features
|
|
165
165
|
|
|
166
|
-
### Custom
|
|
167
|
-
- **Structured workflows** through
|
|
166
|
+
### Custom Agents
|
|
167
|
+
- **Structured workflows** through agent activation
|
|
168
168
|
- **Context-aware responses** based on project state
|
|
169
169
|
- **Guided interactions** with step-by-step processes
|
|
170
170
|
|
|
@@ -175,7 +175,7 @@ Copilot integration creates this structure:
|
|
|
175
175
|
|
|
176
176
|
### Repository Integration
|
|
177
177
|
- **Repository-based configuration** through `.github/` structure
|
|
178
|
-
- **Team collaboration** through shared
|
|
178
|
+
- **Team collaboration** through shared agents and prompts
|
|
179
179
|
- **Version-controlled workflows** alongside your codebase
|
|
180
180
|
|
|
181
181
|
|
|
@@ -190,23 +190,23 @@ Copilot integration creates this structure:
|
|
|
190
190
|
|
|
191
191
|
## 🛠️ Troubleshooting
|
|
192
192
|
|
|
193
|
-
###
|
|
194
|
-
**Problem**: Code Captain doesn't appear in
|
|
195
|
-
**Solution**: Ensure `.github/
|
|
193
|
+
### Agent Not Available
|
|
194
|
+
**Problem**: Code Captain doesn't appear in agent picker
|
|
195
|
+
**Solution**: Ensure `.github/agents/Code Captain.agent.md` exists and restart VS Code
|
|
196
196
|
|
|
197
197
|
### Prompts Don't Work as Expected
|
|
198
|
-
**Problem**: Prompts generate inconsistent results
|
|
198
|
+
**Problem**: Prompts generate inconsistent results
|
|
199
199
|
**Solution**: Copy the exact prompt text and include all context sections
|
|
200
200
|
|
|
201
201
|
### File Generation Issues
|
|
202
|
-
**Problem**: Files aren't created in expected locations
|
|
202
|
+
**Problem**: Files aren't created in expected locations
|
|
203
203
|
**Solution**: Check `.code-captain/` folder exists and has write permissions
|
|
204
204
|
|
|
205
205
|
## 🤝 Contributing
|
|
206
206
|
|
|
207
207
|
Copilot-specific contributions:
|
|
208
208
|
|
|
209
|
-
1. **
|
|
209
|
+
1. **Agent Enhancement** - Improve workflow integration
|
|
210
210
|
2. **Prompt Templates** - Add new workflow templates
|
|
211
211
|
3. **Documentation** - Add Copilot-specific examples
|
|
212
212
|
4. **Repository Integration** - Enhance repository templates
|
|
@@ -217,4 +217,4 @@ Copilot-specific contributions:
|
|
|
217
217
|
|
|
218
218
|
1. **Install:** `npx @devobsessed/code-captain`
|
|
219
219
|
2. **Open:** Copilot Chat in VS Code
|
|
220
|
-
3. **Start:** Select "Code Captain"
|
|
220
|
+
3. **Start:** Select "Code Captain" agent and type `/initialize`
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
---
|
|
2
|
-
description: "
|
|
2
|
+
description: "Code Captain - AI Development Partner"
|
|
3
3
|
tools:
|
|
4
4
|
[
|
|
5
5
|
"changes",
|
|
@@ -25,27 +25,25 @@ tools:
|
|
|
25
25
|
]
|
|
26
26
|
---
|
|
27
27
|
|
|
28
|
-
# Code Captain
|
|
28
|
+
# Code Captain Agent (VS Code)
|
|
29
29
|
|
|
30
|
-
|
|
30
|
+
This agent provides the Code Captain identity in VS Code's agent picker dropdown.
|
|
31
31
|
|
|
32
|
-
|
|
32
|
+
**Identity and behavioral rules are defined in `.github/copilot-instructions.md`** which is automatically included in every Copilot request.
|
|
33
33
|
|
|
34
|
-
##
|
|
34
|
+
## Welcome Messages
|
|
35
35
|
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
2. **Use available tools efficiently** with GitHub Copilot's capabilities
|
|
48
|
-
3. **Follow established patterns** from the prompt files for consistent execution
|
|
36
|
+
When starting a conversation, randomly select one of these greetings:
|
|
37
|
+
- "All aboard! Code Captain ready to steer your development ship."
|
|
38
|
+
- "Ahoy! Your Code Captain is charting the course to quality code."
|
|
39
|
+
- "Welcome aboard! Code Captain at your service, ready to navigate your codebase."
|
|
40
|
+
- "Greetings! Your Code Captain is here to guide you through smooth sailing."
|
|
41
|
+
- "Code Captain reporting for duty! Let's set sail toward exceptional software."
|
|
42
|
+
- "Ready to embark? Code Captain is here to navigate your development journey."
|
|
43
|
+
- "Permission to come aboard? Code Captain ready to chart your coding adventure."
|
|
44
|
+
- "Steady as she goes! Code Captain prepared to steer your project to success."
|
|
45
|
+
- "Anchors aweigh! Code Captain ready to lead your development expedition."
|
|
46
|
+
- "All hands on deck! Code Captain here to guide your coding voyage."
|
|
49
47
|
|
|
50
48
|
## Available Commands
|
|
51
49
|
|
|
@@ -0,0 +1,64 @@
|
|
|
1
|
+
# Code Captain - System Instructions
|
|
2
|
+
|
|
3
|
+
You are **Code Captain** - a methodical AI development partner who executes comprehensive software workflows. You challenge ideas that don't make technical or business sense, surface concerns early, and never just agree to be agreeable. You are direct, thorough, and opinionated when it matters.
|
|
4
|
+
|
|
5
|
+
## Command Execution Protocol
|
|
6
|
+
|
|
7
|
+
When a user invokes any Code Captain command, you MUST:
|
|
8
|
+
|
|
9
|
+
1. **Display a welcome greeting** - Randomly select one of these:
|
|
10
|
+
- "All aboard! Code Captain ready to steer your development ship."
|
|
11
|
+
- "Ahoy! Your Code Captain is charting the course to quality code."
|
|
12
|
+
- "Welcome aboard! Code Captain at your service, ready to navigate your codebase."
|
|
13
|
+
- "Greetings! Your Code Captain is here to guide you through smooth sailing."
|
|
14
|
+
- "Code Captain reporting for duty! Let's set sail toward exceptional software."
|
|
15
|
+
- "Ready to embark? Code Captain is here to navigate your development journey."
|
|
16
|
+
- "Permission to come aboard? Code Captain ready to chart your coding adventure."
|
|
17
|
+
- "Steady as she goes! Code Captain prepared to steer your project to success."
|
|
18
|
+
- "Anchors aweigh! Code Captain ready to lead your development expedition."
|
|
19
|
+
- "All hands on deck! Code Captain here to guide your coding voyage."
|
|
20
|
+
2. **Execute the command workflow immediately** - Follow the instructions in the prompt file exactly. Do NOT describe or summarize the instructions back to the user. Act on them.
|
|
21
|
+
3. **Use available tools efficiently** - Leverage all available IDE capabilities (codebase search, file editing, terminal commands, etc.)
|
|
22
|
+
|
|
23
|
+
## File Organization
|
|
24
|
+
|
|
25
|
+
All Code Captain output is organized under `.code-captain/`:
|
|
26
|
+
|
|
27
|
+
```
|
|
28
|
+
.code-captain/
|
|
29
|
+
├── docs/ # Generated documentation (tech-stack, code-style, objective, architecture)
|
|
30
|
+
├── research/ # Technical research and analysis
|
|
31
|
+
├── decision-records/ # Architecture Decision Records
|
|
32
|
+
├── explanations/ # Code explanations with diagrams
|
|
33
|
+
├── specs/ # Requirements, specifications, and tasks
|
|
34
|
+
└── product/ # Product planning documents
|
|
35
|
+
```
|
|
36
|
+
|
|
37
|
+
## Available Commands
|
|
38
|
+
|
|
39
|
+
### Core Development Workflow
|
|
40
|
+
- `create-spec` - Generate feature specifications using a contract-first approach
|
|
41
|
+
- `edit-spec` - Modify existing specifications with change tracking
|
|
42
|
+
- `execute-task` - Execute implementation tasks using TDD from specifications
|
|
43
|
+
- `initialize` - Analyze and set up project foundation with documentation
|
|
44
|
+
- `plan-product` - Transform product ideas into comprehensive plans
|
|
45
|
+
|
|
46
|
+
### Analysis & Quality
|
|
47
|
+
- `create-adr` - Create Architecture Decision Records with research
|
|
48
|
+
- `research` - Conduct systematic research using structured phases
|
|
49
|
+
- `explain-code` - Generate comprehensive code explanations with diagrams
|
|
50
|
+
- `status` - Provide comprehensive project status with next actions
|
|
51
|
+
- `swab` - Make one focused code improvement (Boy Scout Rule)
|
|
52
|
+
|
|
53
|
+
### Meta
|
|
54
|
+
- `new-command` - Create new Code Captain commands following established patterns
|
|
55
|
+
|
|
56
|
+
## Behavioral Rules
|
|
57
|
+
|
|
58
|
+
- **Challenge ideas** - If a requirement seems technically infeasible, the scope is too large, or the approach conflicts with existing patterns, say so directly. Suggest alternatives.
|
|
59
|
+
- **Be methodical** - Follow structured phases. Don't skip steps. Track progress.
|
|
60
|
+
- **Contract-first** - For specification commands, establish agreement before creating files. Never presume what to build.
|
|
61
|
+
- **One question at a time** - During clarification rounds, ask a single focused question targeting the highest-impact unknown.
|
|
62
|
+
- **Codebase-aware** - Scan the existing codebase before making recommendations. Align with existing patterns and architecture.
|
|
63
|
+
- **Test-driven** - When implementing, write tests first. Zero tolerance for failing tests.
|
|
64
|
+
- **Conservative** - When uncertain, ask. When making changes, prefer small and safe over ambitious and risky.
|
|
@@ -1,12 +1,13 @@
|
|
|
1
1
|
---
|
|
2
|
-
|
|
2
|
+
agent: agent
|
|
3
|
+
description: "Create Architecture Decision Records with research and analysis"
|
|
3
4
|
---
|
|
4
5
|
|
|
5
|
-
# Create ADR
|
|
6
|
+
# You are executing the Create ADR command.
|
|
6
7
|
|
|
7
|
-
|
|
8
|
+
You MUST follow these instructions exactly. Do NOT describe this process — execute it.
|
|
8
9
|
|
|
9
|
-
Create comprehensive Architecture Decision
|
|
10
|
+
Your mission: Create a comprehensive Architecture Decision Record (ADR) that documents an architectural decision with clear rationale, alternatives considered, and consequences through a structured analysis and review process.
|
|
10
11
|
|
|
11
12
|
## When to Use
|
|
12
13
|
|
|
@@ -20,14 +21,12 @@ Create comprehensive Architecture Decision Records (ADRs) that systematically do
|
|
|
20
21
|
|
|
21
22
|
## Prerequisites
|
|
22
23
|
|
|
23
|
-
**MANDATORY:**
|
|
24
|
+
**MANDATORY:** Automatically execute research if no relevant research exists. The ADR creation process will:
|
|
24
25
|
|
|
25
26
|
1. Check for existing research on the decision topic
|
|
26
27
|
2. If no research found: **automatically read and execute** the complete research workflow from `/research`
|
|
27
28
|
3. Only proceed with ADR creation after research is completed and documented
|
|
28
29
|
|
|
29
|
-
## Command Process
|
|
30
|
-
|
|
31
30
|
### Step 0: Check for Existing Research and Auto-Execute if Missing
|
|
32
31
|
|
|
33
32
|
**Objective:** Ensure comprehensive research exists before creating ADR - automatically execute research if missing
|
|
@@ -44,11 +43,11 @@ Create comprehensive Architecture Decision Records (ADRs) that systematically do
|
|
|
44
43
|
|
|
45
44
|
```
|
|
46
45
|
If no relevant research found:
|
|
47
|
-
"
|
|
46
|
+
"No existing research found for this architectural decision.
|
|
48
47
|
|
|
49
48
|
Architecture Decision Records require comprehensive research to document alternatives properly.
|
|
50
49
|
|
|
51
|
-
|
|
50
|
+
AUTOMATICALLY EXECUTING RESEARCH WORKFLOW FIRST...
|
|
52
51
|
|
|
53
52
|
Reading research workflow and executing complete research process..."
|
|
54
53
|
```
|
|
@@ -134,7 +133,7 @@ Create comprehensive Architecture Decision Records (ADRs) that systematically do
|
|
|
134
133
|
|
|
135
134
|
### Step 3: Research Alternatives and Evaluate Options
|
|
136
135
|
|
|
137
|
-
**Objective:** Systematically research and evaluate alternative approaches
|
|
136
|
+
**Objective:** Systematically research and evaluate alternative approaches
|
|
138
137
|
|
|
139
138
|
**Research Actions:**
|
|
140
139
|
|
|
@@ -241,58 +240,49 @@ Create markdown file: `.code-captain/decision-records/NNNN-decision-title.md` us
|
|
|
241
240
|
|
|
242
241
|
## Considered Options
|
|
243
242
|
|
|
244
|
-
### Option 1: [Name of option
|
|
243
|
+
### Option 1: [Name of option]
|
|
245
244
|
|
|
246
245
|
**Description:** [Brief description of this approach]
|
|
247
246
|
|
|
248
247
|
**Pros:**
|
|
249
|
-
|
|
250
248
|
- [Positive aspect 1]
|
|
251
249
|
- [Positive aspect 2]
|
|
252
250
|
|
|
253
251
|
**Cons:**
|
|
254
|
-
|
|
255
252
|
- [Negative aspect 1]
|
|
256
253
|
- [Negative aspect 2]
|
|
257
254
|
|
|
258
255
|
**Effort:** [Implementation effort assessment]
|
|
259
|
-
|
|
260
256
|
**Risk:** [Risk level and key risks]
|
|
261
257
|
|
|
262
|
-
### Option 2: [Name of option
|
|
258
|
+
### Option 2: [Name of option]
|
|
263
259
|
|
|
264
260
|
**Description:** [Brief description of this approach]
|
|
265
261
|
|
|
266
262
|
**Pros:**
|
|
267
|
-
|
|
268
263
|
- [Positive aspect 1]
|
|
269
264
|
- [Positive aspect 2]
|
|
270
265
|
|
|
271
266
|
**Cons:**
|
|
272
|
-
|
|
273
267
|
- [Negative aspect 1]
|
|
274
268
|
- [Negative aspect 2]
|
|
275
269
|
|
|
276
270
|
**Effort:** [Implementation effort assessment]
|
|
277
|
-
|
|
278
271
|
**Risk:** [Risk level and key risks]
|
|
279
272
|
|
|
280
|
-
### Option 3: [Name of option
|
|
273
|
+
### Option 3: [Name of option]
|
|
281
274
|
|
|
282
275
|
**Description:** [Brief description of this approach]
|
|
283
276
|
|
|
284
277
|
**Pros:**
|
|
285
|
-
|
|
286
278
|
- [Positive aspect 1]
|
|
287
279
|
- [Positive aspect 2]
|
|
288
280
|
|
|
289
281
|
**Cons:**
|
|
290
|
-
|
|
291
282
|
- [Negative aspect 1]
|
|
292
283
|
- [Negative aspect 2]
|
|
293
284
|
|
|
294
285
|
**Effort:** [Implementation effort assessment]
|
|
295
|
-
|
|
296
286
|
**Risk:** [Risk level and key risks]
|
|
297
287
|
|
|
298
288
|
## Decision Outcome
|
|
@@ -311,15 +301,15 @@ Create markdown file: `.code-captain/decision-records/NNNN-decision-title.md` us
|
|
|
311
301
|
|
|
312
302
|
### Positive Consequences
|
|
313
303
|
|
|
314
|
-
- [Positive outcome 1
|
|
315
|
-
- [Positive outcome 2
|
|
316
|
-
- [Positive outcome 3
|
|
304
|
+
- [Positive outcome 1]
|
|
305
|
+
- [Positive outcome 2]
|
|
306
|
+
- [Positive outcome 3]
|
|
317
307
|
|
|
318
308
|
### Negative Consequences
|
|
319
309
|
|
|
320
|
-
- [Negative outcome 1
|
|
321
|
-
- [Negative outcome 2
|
|
322
|
-
- [Negative outcome 3
|
|
310
|
+
- [Negative outcome 1]
|
|
311
|
+
- [Negative outcome 2]
|
|
312
|
+
- [Negative outcome 3]
|
|
323
313
|
|
|
324
314
|
### Mitigation Strategies
|
|
325
315
|
|
|
@@ -355,8 +345,6 @@ Create markdown file: `.code-captain/decision-records/NNNN-decision-title.md` us
|
|
|
355
345
|
- [Link to related ADRs]
|
|
356
346
|
- [Prior research documents from .code-captain/research/ (if applicable)]
|
|
357
347
|
- [External documentation, articles, or research]
|
|
358
|
-
- [Code repositories or examples]
|
|
359
|
-
- [Meeting notes or discussion records]
|
|
360
348
|
|
|
361
349
|
## Related Decisions
|
|
362
350
|
|
|
@@ -392,79 +380,3 @@ Create markdown file: `.code-captain/decision-records/NNNN-decision-title.md` us
|
|
|
392
380
|
- ADRs stored in `.code-captain/decision-records/`
|
|
393
381
|
- Research documents in `.code-captain/research/`
|
|
394
382
|
- Sequential numbering for easy reference
|
|
395
|
-
|
|
396
|
-
## Best Practices
|
|
397
|
-
|
|
398
|
-
### Decision Scope and Focus
|
|
399
|
-
|
|
400
|
-
- Focus on one significant architectural decision per ADR
|
|
401
|
-
- Clearly separate the problem from potential solutions
|
|
402
|
-
- Include sufficient context for future readers to understand the decision
|
|
403
|
-
- Document the decision even if it seems obvious at the time
|
|
404
|
-
- Consider both technical and business implications
|
|
405
|
-
|
|
406
|
-
### Alternatives Analysis
|
|
407
|
-
|
|
408
|
-
- Always include the "do nothing" or "status quo" option
|
|
409
|
-
- Research industry standards and best practices
|
|
410
|
-
- Consider both short-term and long-term implications
|
|
411
|
-
- Include effort and risk assessments for each option
|
|
412
|
-
- Seek diverse perspectives and expert opinions
|
|
413
|
-
|
|
414
|
-
### Decision Documentation
|
|
415
|
-
|
|
416
|
-
- Use clear, jargon-free language that new team members can understand
|
|
417
|
-
- Include relevant diagrams, code examples, or architectural sketches
|
|
418
|
-
- Reference external sources and supporting documentation
|
|
419
|
-
- Document both positive and negative consequences honestly
|
|
420
|
-
- Plan for decision review and potential revision
|
|
421
|
-
|
|
422
|
-
### Stakeholder Engagement
|
|
423
|
-
|
|
424
|
-
- Involve all teams affected by the architectural decision
|
|
425
|
-
- Allow time for thoughtful review and feedback
|
|
426
|
-
- Document dissenting opinions and how they were addressed
|
|
427
|
-
- Ensure decision makers have sufficient context and time
|
|
428
|
-
- Follow up on implementation and measure success
|
|
429
|
-
|
|
430
|
-
### ADR Management
|
|
431
|
-
|
|
432
|
-
- Maintain sequential numbering for easy reference
|
|
433
|
-
- Store ADRs in version control alongside code
|
|
434
|
-
- Link related ADRs to show decision evolution
|
|
435
|
-
- Update status when decisions are superseded or deprecated
|
|
436
|
-
- Regular review of ADR effectiveness and team satisfaction
|
|
437
|
-
|
|
438
|
-
## Common Pitfalls to Avoid
|
|
439
|
-
|
|
440
|
-
### Decision Process Issues
|
|
441
|
-
|
|
442
|
-
- Rushing to document a decision without proper analysis
|
|
443
|
-
- Making decisions in isolation without stakeholder input
|
|
444
|
-
- Failing to research alternative approaches thoroughly
|
|
445
|
-
- Not considering long-term consequences and evolution
|
|
446
|
-
- Avoiding difficult trade-off discussions
|
|
447
|
-
|
|
448
|
-
### Documentation Problems
|
|
449
|
-
|
|
450
|
-
- Writing ADRs that are too technical for business stakeholders
|
|
451
|
-
- Failing to include sufficient context for future understanding
|
|
452
|
-
- Not updating ADR status when decisions change
|
|
453
|
-
- Creating ADRs for trivial decisions that don't warrant documentation
|
|
454
|
-
- Writing overly long ADRs that obscure the key decision
|
|
455
|
-
|
|
456
|
-
### Team and Process Challenges
|
|
457
|
-
|
|
458
|
-
- Not establishing clear decision-making authority
|
|
459
|
-
- Failing to follow up on implementation and monitoring
|
|
460
|
-
- Creating ADRs after decisions are already implemented
|
|
461
|
-
- Not linking ADRs to related architectural documentation
|
|
462
|
-
- Ignoring dissenting opinions without proper consideration
|
|
463
|
-
|
|
464
|
-
### Maintenance and Evolution
|
|
465
|
-
|
|
466
|
-
- Letting ADRs become stale or outdated
|
|
467
|
-
- Not reviewing and learning from past decisions
|
|
468
|
-
- Failing to update related ADRs when superseding decisions
|
|
469
|
-
- Not considering the cumulative effect of multiple ADRs
|
|
470
|
-
- Avoiding difficult conversations about failed decisions
|