Skip to content

Commit ea9925f

Browse files
authored
Merge pull request #63 from maystudios/worktree-agent-a43bc005
docs: add artefakte and discussion docs to help reference
2 parents 3043cd3 + a4c133f commit ea9925f

File tree

1 file changed

+23
-0
lines changed

1 file changed

+23
-0
lines changed

templates/workflows/help.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -267,6 +267,7 @@ Capture idea or task as todo from current conversation.
267267

268268
Usage: `/maxsim:add-todo` (infers from conversation)
269269
Usage: `/maxsim:add-todo Add auth token refresh`
270+
Usage: `/maxsim:add-todo --discuss Refactor auth module` (collaborative discussion before filing)
270271

271272
**`/maxsim:check-todos [area]`**
272273
List pending todos and select one to work on.
@@ -280,6 +281,25 @@ List pending todos and select one to work on.
280281
Usage: `/maxsim:check-todos`
281282
Usage: `/maxsim:check-todos api`
282283

284+
### Artefakte Management
285+
286+
**`/maxsim:artefakte [type] [--phase <N>]`**
287+
View and manage project decisions, acceptance criteria, and no-gos.
288+
289+
- No arguments: lists all artefakte documents with status
290+
- With type (`decisions`, `acceptance-criteria`, `no-gos`): view specific document
291+
- With `--phase N`: scope to phase-level artefakte
292+
- Interactive: add entries, view documents, switch between types
293+
294+
Artefakte documents:
295+
- `DECISIONS.md` — Architectural and design decisions with rationale
296+
- `ACCEPTANCE-CRITERIA.md` — Conditions that must be met for deliverables
297+
- `NO-GOS.md` — Things explicitly out of scope or forbidden
298+
299+
Usage: `/maxsim:artefakte`
300+
Usage: `/maxsim:artefakte decisions`
301+
Usage: `/maxsim:artefakte no-gos --phase 3`
302+
283303
### User Acceptance Testing
284304

285305
**`/maxsim:verify-work [phase]`**
@@ -367,6 +387,9 @@ Usage: `/maxsim:update`
367387
├── PROJECT.md # Project vision
368388
├── ROADMAP.md # Current phase breakdown
369389
├── STATE.md # Project memory & context
390+
├── DECISIONS.md # Architectural decisions with rationale
391+
├── ACCEPTANCE-CRITERIA.md # Success conditions for deliverables
392+
├── NO-GOS.md # Explicit exclusions and boundaries
370393
├── config.json # Workflow mode & gates
371394
├── todos/ # Captured ideas and tasks
372395
│ ├── pending/ # Todos waiting to be worked on

0 commit comments

Comments
 (0)