@leeovery/claude-technical-workflows 2.0.5 → 2.0.7
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
CHANGED
|
@@ -1,10 +1,11 @@
|
|
|
1
1
|
<h1 align="center">Claude Technical Workflows</h1>
|
|
2
2
|
|
|
3
3
|
<p align="center">
|
|
4
|
-
<strong>
|
|
4
|
+
<strong>From Idea to Implementation: Software Engineering Workflows for Claude Code</strong>
|
|
5
5
|
</p>
|
|
6
6
|
|
|
7
7
|
<p align="center">
|
|
8
|
+
<a href="#how-do-i-use-this">How to Use</a> •
|
|
8
9
|
<a href="#installation">Installation</a> •
|
|
9
10
|
<a href="#the-six-phase-workflow">Workflow</a> •
|
|
10
11
|
<a href="#skills">Skills</a> •
|
|
@@ -24,12 +25,61 @@
|
|
|
24
25
|
|
|
25
26
|
## About
|
|
26
27
|
|
|
27
|
-
A
|
|
28
|
+
A six-phase workflow for Claude Code that captures context, decisions, and rationale before any code is written, then implements and validates the work against those artifacts.
|
|
28
29
|
|
|
29
|
-
|
|
30
|
+
```
|
|
31
|
+
Research → Explore ideas
|
|
32
|
+
↓
|
|
33
|
+
Discussion → Debate and decide
|
|
34
|
+
↓
|
|
35
|
+
Specification → Validate and refine
|
|
36
|
+
↓
|
|
37
|
+
Planning → Structure the work
|
|
38
|
+
↓
|
|
39
|
+
Implementation → Build via TDD
|
|
40
|
+
↓
|
|
41
|
+
Review → Validate against spec
|
|
42
|
+
```
|
|
43
|
+
|
|
44
|
+
**Why this matters:** Complex features benefit from thorough discussion before implementation. These skills help you document the *what* and *why* before diving into the *how*, preserving architectural decisions, edge cases, and the reasoning behind choices that would otherwise be lost.
|
|
30
45
|
|
|
31
46
|
**This is a work in progress.** The workflow is being refined through real-world usage. Expect updates as patterns evolve.
|
|
32
47
|
|
|
48
|
+
## How do I use this?
|
|
49
|
+
|
|
50
|
+
You have two entry points:
|
|
51
|
+
|
|
52
|
+
| Start here... | When... | Command |
|
|
53
|
+
|---------------|---------|---------|
|
|
54
|
+
| **Research** | You have a fresh idea to explore: feasibility, market, viability, early thoughts | `/start-research` |
|
|
55
|
+
| **Discussion** | You already know what you're building and need to iron out the details | `/start-discussion` |
|
|
56
|
+
|
|
57
|
+
**Research** is a free-for-all. Explore broadly, follow tangents, challenge assumptions. Not everything researched gets built, and that's fine. Use this for ideas that need validating before you commit.
|
|
58
|
+
|
|
59
|
+
**Discussion** is where you work through the challenging parts: core architecture, edge cases, non-obvious decisions. The key value is that it captures *how* you arrived at decisions, not just the decisions themselves. When you explore four approaches and pick one, the document explains why you rejected the others. This context is invaluable later.
|
|
60
|
+
|
|
61
|
+
Then follow the flow:
|
|
62
|
+
|
|
63
|
+
```
|
|
64
|
+
Research → Discussion → Specification → Planning → Implementation → Review
|
|
65
|
+
```
|
|
66
|
+
|
|
67
|
+
Each phase builds on the previous. Specification validates your discussions into a standalone doc. Planning breaks that into tasks. Implementation executes via TDD. Review validates against the spec.
|
|
68
|
+
|
|
69
|
+
### Commands
|
|
70
|
+
|
|
71
|
+
Each phase has a command designed as its entry point:
|
|
72
|
+
|
|
73
|
+
| Phase | Command |
|
|
74
|
+
|-------|---------|
|
|
75
|
+
| Research | `/start-research` |
|
|
76
|
+
| Discussion | `/start-discussion` |
|
|
77
|
+
| Specification | `/start-specification` |
|
|
78
|
+
| Planning | `/start-planning` |
|
|
79
|
+
| Implementation | `/start-implementation` |
|
|
80
|
+
|
|
81
|
+
Run the command directly or ask Claude to run it. Each command gathers the context it needs, asking what you're researching, discussing, or planning. Where relevant, it looks at outputs from the previous phase and offers you a choice from the list.
|
|
82
|
+
|
|
33
83
|
## Installation
|
|
34
84
|
|
|
35
85
|
### npm
|
|
@@ -48,13 +98,15 @@ pnpm approve-builds # approve when prompted
|
|
|
48
98
|
pnpm install # triggers postinstall
|
|
49
99
|
```
|
|
50
100
|
|
|
51
|
-
|
|
101
|
+
### Removal
|
|
102
|
+
|
|
103
|
+
Due to bugs in npm 7+ ([issue #3042](https://github.com/npm/cli/issues/3042)) and pnpm ([issue #3276](https://github.com/pnpm/pnpm/issues/3276)), preuninstall hooks don't run reliably. Remove files manually first:
|
|
52
104
|
|
|
53
105
|
```bash
|
|
54
|
-
npx
|
|
106
|
+
npx claude-manager remove @leeovery/claude-technical-workflows && npm rm @leeovery/claude-technical-workflows
|
|
55
107
|
```
|
|
56
108
|
|
|
57
|
-
The [Claude Manager](https://github.com/leeovery/claude-manager) copies skills to `.claude/` automatically.
|
|
109
|
+
The [Claude Manager](https://github.com/leeovery/claude-manager) copies skills, commands, and agents to `.claude/` automatically.
|
|
58
110
|
|
|
59
111
|
## The Six-Phase Workflow
|
|
60
112
|
|
|
@@ -108,6 +160,7 @@ Documents are stored using a **phase-first** organization:
|
|
|
108
160
|
```
|
|
109
161
|
docs/workflow/
|
|
110
162
|
├── research/ # Phase 1 - flat, semantically named files
|
|
163
|
+
│ ├── exploration.md
|
|
111
164
|
│ ├── competitor-analysis.md
|
|
112
165
|
│ └── pricing-models.md
|
|
113
166
|
├── discussion/ # Phase 2 - one file per topic
|
|
@@ -118,7 +171,7 @@ docs/workflow/
|
|
|
118
171
|
└── {topic}.md
|
|
119
172
|
```
|
|
120
173
|
|
|
121
|
-
Research
|
|
174
|
+
Research starts with `exploration.md` and splits into topic files as themes emerge. From discussion onwards, each topic gets its own file per phase.
|
|
122
175
|
|
|
123
176
|
### Package Structure
|
|
124
177
|
|
|
@@ -258,6 +311,7 @@ Slash commands to quickly invoke the workflow.
|
|
|
258
311
|
| [**/start-discussion**](commands/start-discussion.md) | Begin a new technical discussion. Gathers topic, context, background information, and relevant codebase areas before starting documentation. |
|
|
259
312
|
| [**/start-specification**](commands/start-specification.md) | Start a specification session from an existing discussion. Validates and refines discussion content into a standalone specification. |
|
|
260
313
|
| [**/start-planning**](commands/start-planning.md) | Start a planning session from an existing specification. Creates implementation plans with phases, tasks, and acceptance criteria. Supports multiple output formats (markdown, Linear, Backlog.md, Beads). |
|
|
314
|
+
| [**/start-implementation**](commands/start-implementation.md) | Start implementing a plan. Executes tasks via strict TDD, committing after each passing test. |
|
|
261
315
|
| [**/interview**](commands/interview.md) | Shift into focused questioning mode during research or discussion. Probes ideas with non-obvious questions, challenges assumptions, and surfaces concerns. |
|
|
262
316
|
|
|
263
317
|
## Agents
|
|
@@ -59,6 +59,7 @@ After the user selects a plan:
|
|
|
59
59
|
2. If it exists, note the file location for the skill handoff
|
|
60
60
|
3. If missing, ask: "Are there any environment setup instructions I should follow?"
|
|
61
61
|
- If the user provides instructions, save them to `docs/workflow/environment-setup.md`, commit and push to Git
|
|
62
|
+
- If the user says no, create `docs/workflow/environment-setup.md` with "No special setup required." and commit. This prevents asking again in future sessions.
|
|
62
63
|
- See `skills/technical-implementation/references/environment-setup.md` for format guidance
|
|
63
64
|
|
|
64
65
|
## Step 4: Ask About Scope
|
package/package.json
CHANGED
|
@@ -39,7 +39,8 @@ Complete ALL setup steps before proceeding to implementation work.
|
|
|
39
39
|
|
|
40
40
|
1. **Check environment setup** (if not already done)
|
|
41
41
|
- Look for `docs/workflow/environment-setup.md`
|
|
42
|
-
- If exists
|
|
42
|
+
- If exists and states "No special setup required", skip to step 2
|
|
43
|
+
- If exists with instructions, follow the setup before proceeding
|
|
43
44
|
- If missing, ask: "Are there any environment setup instructions I should follow?"
|
|
44
45
|
|
|
45
46
|
See **[environment-setup.md](references/environment-setup.md)** for details.
|
|
@@ -44,6 +44,12 @@ If they provide instructions, offer to save them:
|
|
|
44
44
|
|
|
45
45
|
> "Would you like me to save these instructions to `docs/workflow/environment-setup.md` for future sessions?"
|
|
46
46
|
|
|
47
|
+
If they say no setup is needed, create `docs/workflow/environment-setup.md` with "No special setup required." and commit. This prevents asking the same question in future sessions.
|
|
48
|
+
|
|
49
|
+
## No Setup Required
|
|
50
|
+
|
|
51
|
+
If the environment setup document contains only "No special setup required" (or similar), skip environment setup and proceed directly to reading the plan.
|
|
52
|
+
|
|
47
53
|
## Plan Format Setup
|
|
48
54
|
|
|
49
55
|
Some plan formats require specific tools. Check the plan's `format` field and load the corresponding output adapter from the planning skill for setup instructions:
|