Skip to content

Commit 8f349ab

Browse files
Add Wordle tutorial and reorganize tutorial docs
1 parent 87db195 commit 8f349ab

3 files changed

Lines changed: 840 additions & 18 deletions

File tree

README.md

Lines changed: 16 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -189,11 +189,20 @@ project-specific settings such as `<TASK_DIR>` and local requirements.
189189
It explains how task files and the Constitution map to team development practice: boundaries,
190190
responsibility, commit linking, and status discipline.
191191

192-
4. Follow the hands-on tutorial.
193-
194-
* **[Spec Loop Tutorial](docs/tutorial.md)** walks through a complete
195-
end-to-end example with staged planning, approvals, implementation,
196-
and testing.
192+
4. Follow one of the hands-on tutorials.
193+
194+
* **[Wordle Tutorial](docs/wordle-tutorial.md)** walks through a
195+
compact Java example with staged planning, approvals,
196+
implementation, glossary maintenance, and testing.
197+
* **[Online Art Game Tutorial](docs/online-art-game-tutorial.md)**
198+
walks through a complete browser-oriented example with staged
199+
planning, approvals, implementation, and testing.
200+
* The two tutorials teach the same Spec Loop workflow: planning
201+
first, explicit approval before implementation, small reviewable
202+
tasks or subtasks, verification, and user correction when the LLM
203+
misses a supporting update. The main difference is the technical
204+
setting: Wordle is a compact Java path, while the online art game
205+
is browser-oriented. You can choose either tutorial.
197206

198207
5. Project glossary conventions.
199208

@@ -205,7 +214,8 @@ Recommended quick-check order:
205214
- `README.md`
206215
- `CONSTITUTION.md`
207216
- `docs/review-responsibility-and-traceability.md`
208-
- `docs/tutorial.md`
217+
- `docs/online-art-game-tutorial.md`
218+
- `docs/wordle-tutorial.md`
209219

210220
## Diagrams and PlantUML
211221

Lines changed: 18 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Spec Loop Tutorial: You Send, You See
1+
# Online Art Game Tutorial: You Send, You See
22

33
This tutorial is intentionally compact and execution-focused.
44
It is optimized to demonstrate a broad range of Spec Loop mechanisms in
@@ -186,6 +186,8 @@ Each following tutorial step uses the same structure:
186186
- ‘You send’ shows a suitable message to send to the LLM. Any equivalent wording is fine.
187187
- This tutorial assumes `glossary.adoc` is created in
188188
Step 1 and then maintained throughout the later steps.
189+
Once it exists, the LLM should treat it as ordinary project context
190+
rather than needing that reminder in every later prompt.
189191
- Governance and workflow gates (from the copied [AGENTS.md](../AGENTS.md) and
190192
[CONSTITUTION.md](../CONSTITUTION.md)) are expected to be loaded by your LLM tool
191193
automatically. [glossary-skill.md](../glossary-skill.md) is expected next to
@@ -223,6 +225,19 @@ always ask it to check the task or subtask against
223225
If you notice files in the change set that should be ignored, you can
224226
tell the LLM to fix that.
225227

228+
## Possible misalignment
229+
230+
If one of these happens, interrupt the flow and ask the LLM to correct
231+
it before you continue:
232+
233+
- Implementation starts before explicit approval.
234+
- Unrelated changes are mixed into one subtask.
235+
- Implementation changes are made without verification evidence.
236+
- A supporting artifact such as `glossary.adoc`, task status, or ignore
237+
rules was not updated when the change clearly requires it.
238+
- A task or subtask is moved to `done` without explicit user
239+
confirmation.
240+
226241
## Step 1: Project README ([README.md](../README.md))
227242

228243
### You send
@@ -459,7 +474,6 @@ Reuse earlier task-file research where relevant, but keep future
459474
subtasks lightweight. We will flesh out only the current subtask before
460475
implementation.
461476
462-
Use `glossary.adoc` as the terminology reference.
463477
```
464478

465479
### You see (plan)
@@ -540,8 +554,8 @@ subtask. Create only:
540554
Keep future implementation subtasks lightweight. We will flesh out only
541555
the current subtask before implementation.
542556
543-
Use `glossary.adoc` during planning as the reference for leaderboard
544-
terms and definitions.
557+
Keep leaderboard terminology aligned with the established project
558+
language.
545559
```
546560

547561
### You see (plan)
@@ -669,11 +683,3 @@ How to think while running this tutorial:
669683
- Chat is for coordination and approvals; task files and ADRs are the
670684
durable specification artifacts.
671685
- Only the user may relax or override Constitution workflow rules.
672-
673-
Common anti-patterns:
674-
675-
- Implementation starts before explicit approval.
676-
- Unrelated changes are mixed into one subtask.
677-
- Implementation changes are made without verification evidence.
678-
- A task or subtask is moved to `done` without explicit user
679-
confirmation.

0 commit comments

Comments
 (0)