usecasegen-cli/ucgen.yaml.example at main · Aureum01/usecasegen-cli · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
# ucgen.yaml — Project use case definition
# Run: ucgen run       (generate all pending)
# Run: ucgen status    (check generation status)

project:
  name: MyProject
  domain: healthcare
  stack: python-fastapi-postgres
  version: "1.0"

defaults:
  provider: ollama
  model: mistral
  template: default
  output_dir: ./use-cases

actors:
  - name: Patient
    description: Registered patient with an active account
    type: human

  - name: Receptionist
    description: Clinic staff member managing bookings
    type: human

  - name: BillingSystem
    description: External insurance and payment processor
    type: system

use_cases:
  - id: UC-001
    title: Book Appointment
    actor: Patient
    goal: Reserve an available slot with a preferred provider
    priority: high
    tags: [booking, core]
    status: pending

  - id: UC-002
    title: Cancel Appointment
    actor: Patient
    goal: Cancel an existing confirmed appointment with optional reason
    priority: high
    tags: [booking, core]
    status: pending

  - id: UC-003
    title: Check In Patient
    actor: Receptionist
    goal: Record patient arrival and notify the assigned provider
    priority: medium
    tags: [reception]
    status: pending

# hooks:
#   on_generate: "git add {file}"
#   on_batch_complete: "echo 'Generated {count} use cases for {project}'"