Skip to content

Commit 3fdec0d

Browse files
authored
docs(readme): slim Workflow to the core loop, expand Quick Example (#988)
1 parent 5e0c261 commit 3fdec0d

1 file changed

Lines changed: 42 additions & 19 deletions

File tree

README.md

Lines changed: 42 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -26,48 +26,71 @@ The point is not ceremony. The point is leverage. A good brainstorm makes the pl
2626

2727
## Workflow
2828

29-
`/ce-strategy` is upstream of the loop -- it captures the product's target problem, approach, persona, metrics, and tracks as a short durable anchor at `STRATEGY.md`. Ideate, brainstorm, and plan read it as grounding when present, so strategy choices flow into feature conception, prioritization, and spec.
30-
31-
The core loop is: brainstorm the requirements, plan the implementation, work through the plan, review the result, compound the learning, then repeat with better context.
32-
33-
Use `/ce-ideate` before the loop when you want the agent to generate and critique bigger ideas before choosing one to brainstorm. It produces a ranked ideation artifact, not requirements, plans, or code.
29+
The core loop is six steps: **brainstorm** the requirements, **plan** the implementation, **work** through the plan, **simplify** what you wrote, **review** the result, then **compound** the learning -- and repeat with better context.
3430

3531
| Skill | Purpose |
3632
|-------|---------|
37-
| `/ce-strategy` | Create or maintain `STRATEGY.md` -- the product's target problem, approach, persona, key metrics, and tracks. Read as grounding by ideate, brainstorm, and plan |
38-
| `/ce-ideate` | Optional big-picture ideation: generate and critically evaluate grounded ideas, then route the strongest one into brainstorming |
39-
| `/ce-brainstorm` | Interactive Q&A to think through a feature or problem and write a right-sized requirements doc before planning |
40-
| `/ce-plan` | Turn feature ideas into detailed implementation plans |
41-
| `/ce-work` | Execute plans with worktrees and task tracking |
42-
| `/ce-debug` | Systematically reproduce failures, trace root cause, and implement fixes |
43-
| `/ce-code-review` | Multi-agent code review before merging |
44-
| `/ce-compound` | Document learnings to make future work easier |
45-
| `/ce-product-pulse` | Generate a single-page, time-windowed pulse report on usage, performance, errors, and followups. Saves to `docs/pulse-reports/` |
33+
| `/ce-brainstorm` | Interactive Q&A to think through a feature or problem and write a right-sized requirements doc |
34+
| `/ce-plan` | Turn the requirements into a detailed implementation plan with guardrails |
35+
| `/ce-work` | Execute the plan with worktrees and task tracking |
36+
| `/ce-simplify-code` | Refine the freshly written code for clarity and reuse before review |
37+
| `/ce-code-review` | Multi-agent review against the plan before merging |
38+
| `/ce-compound` | Capture the learning into `docs/solutions/` so the next loop starts smarter |
39+
40+
Each cycle compounds: `/ce-compound` writes learnings that the next `/ce-brainstorm` and `/ce-plan` read as grounding -- brainstorms sharpen plans, plans inform future plans, reviews catch more issues, patterns get documented. That return arrow is the whole point.
41+
42+
### Additional skills
4643

47-
`/ce-product-pulse` is the read-side companion -- a time-windowed report on what users actually experienced and how the product performed over a given window (24h, 7d, etc.), saved to `docs/pulse-reports/` so past pulses form a browseable timeline of user outcomes. The next strategy update and the next brainstorm get real signal to anchor to.
44+
These sit around the loop or get reached for on demand -- not every cycle needs them.
4845

49-
Each cycle compounds: brainstorms sharpen plans, plans inform future plans, reviews catch more issues, patterns get documented.
46+
| Skill | When to reach for it |
47+
|-------|---------|
48+
| `/ce-ideate` | *Before the loop*, when you don't yet know what to build -- generates and critically ranks grounded ideas, then routes the strongest one into `/ce-brainstorm` |
49+
| `/ce-strategy` | *Upstream anchor* -- creates and maintains `STRATEGY.md`, read as grounding by ideate, brainstorm, and plan so strategy choices flow into every feature |
50+
| `/ce-product-pulse` | *Outer loop* -- a time-windowed report on what users actually experienced (usage, performance, errors), saved to `docs/pulse-reports/`; its follow-ups feed back into ideation and brainstorming |
51+
| `/ce-debug` | *Instead of brainstorm -> plan -> work* when the input is a bug rather than a feature -- reproduce, trace the causal chain to root cause, then fix |
52+
53+
For the full catalog and how each skill chains together, see [docs/skills](docs/skills/README.md). The complete inventory is [below](#full-skill-inventory).
5054

5155
## Quick Example
5256

53-
A typical cycle starts by turning a rough idea into a requirements doc, then planning from that doc before handing execution to `/ce-work`:
57+
**Finding a direction** -- when you don't have a specific idea yet, ideate first, then carry the strongest survivor into the loop:
58+
59+
```text
60+
/ce-ideate "new drawing tools"
61+
/ce-ideate github issues # ground ideas in your open issues instead of a prompt
62+
```
63+
64+
`/ce-ideate` does the homework first (codebase, past learnings, prior art on the web, optionally your issue tracker), then hands you a ranked set of grounded candidates to take into `/ce-brainstorm`.
65+
66+
**Standard feature loop** -- turn a rough idea into shipped, reviewed code:
5467

5568
```text
5669
/ce-brainstorm "make background job retries safer"
57-
/ce-plan docs/brainstorms/background-job-retry-safety-requirements.md
70+
/ce-plan
5871
/ce-work
72+
/ce-simplify-code
5973
/ce-code-review
6074
/ce-compound
6175
```
6276

63-
For a focused bug investigation:
77+
**Debugging a bug** -- when you start from broken behavior instead of a feature:
6478

6579
```text
6680
/ce-debug "the checkout webhook sometimes creates duplicate invoices"
6781
/ce-code-review
6882
/ce-compound
6983
```
7084

85+
**Autonomous** -- hand off a feature and let the agent run the whole pipeline:
86+
87+
```text
88+
/ce-brainstorm "describe the feature"
89+
/lfg
90+
```
91+
92+
`/lfg` runs the loop hands-off: it plans, works through the plan, simplifies, runs code review and applies the fixes, runs browser tests, commits, pushes, opens a PR, then watches CI and repairs failures until it's green. Start it after `/ce-brainstorm` so it plans against real requirements rather than a one-line prompt. It's the autopilot version of the standard loop -- neat when you want to step away and come back to an open, green PR.
93+
7194
## Getting Started
7295

7396
After installing, run `/ce-setup` in any project. It checks repo-local config, reports optional tool capabilities, and helps keep machine-local CE settings safely gitignored.

0 commit comments

Comments
 (0)