Skip to content

Commit c7f9a02

Browse files
author
zenus
committed
docs: add refine-plan to README and usage
1 parent 1bacbec commit c7f9a02

2 files changed

Lines changed: 26 additions & 3 deletions

File tree

README.md

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -44,12 +44,17 @@ Requires [codex CLI](https://github.com/openai/codex) for review. See the full [
4444
/humanize:gen-plan --input draft.md --output docs/plan.md
4545
```
4646

47-
2. **Run the loop**:
47+
2. **Refine an annotated plan** before implementation when reviewers add `CMT:` ... `ENDCMT` comments:
48+
```bash
49+
/humanize:refine-plan --input docs/plan.md
50+
```
51+
52+
3. **Run the loop**:
4853
```bash
4954
/humanize:start-rlcr-loop docs/plan.md
5055
```
5156

52-
3. **Monitor progress**:
57+
4. **Monitor progress**:
5358
```bash
5459
source <path/to/humanize>/scripts/humanize.sh
5560
humanize monitor rlcr

docs/usage.md

Lines changed: 19 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,21 @@ Humanize creates an iterative feedback loop with two phases:
1111

1212
The loop continues until all acceptance criteria are met or no issues remain.
1313

14+
## Typical Planning Flow
15+
16+
1. Generate the initial implementation plan:
17+
```bash
18+
/humanize:gen-plan --input draft.md --output docs/plan.md
19+
```
20+
2. If the plan is reviewed with `CMT:` ... `ENDCMT` annotations, refine it and generate a QA ledger:
21+
```bash
22+
/humanize:refine-plan --input docs/plan.md
23+
```
24+
3. Start the RLCR loop on the refined plan:
25+
```bash
26+
/humanize:start-rlcr-loop docs/plan.md
27+
```
28+
1429
## Commands
1530

1631
| Command | Purpose |
@@ -68,6 +83,7 @@ OPTIONS:
6883
--discussion Use discussion mode (iterative Claude/Codex convergence rounds)
6984
--direct Use direct mode (skip convergence rounds, proceed immediately to plan)
7085
-h, --help Show help message
86+
```
7187

7288
The gen-plan command transforms rough draft documents into structured implementation plans.
7389

@@ -78,7 +94,9 @@ Workflow:
7894
4. Engages user to resolve any issues found
7995
5. Generates a structured plan.md with acceptance criteria
8096
6. Optionally starts `/humanize:start-rlcr-loop` if `--auto-start-rlcr-if-converged` conditions are met
81-
```
97+
98+
If reviewers later annotate the generated plan with `CMT:` ... `ENDCMT` blocks, run
99+
`/humanize:refine-plan --input <plan.md>` before starting or resuming implementation.
82100

83101
### refine-plan
84102

0 commit comments

Comments
 (0)