Skip to content

Commit 33d861f

Browse files
TriplEightAlexLgn
andauthored
Apply suggestions from code review
Co-authored-by: AlexLgn <[email protected]>
1 parent 73aad1c commit 33d861f

File tree

1 file changed

+68
-38
lines changed

1 file changed

+68
-38
lines changed

.github/ISSUE_TEMPLATE/case.md

Lines changed: 68 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -7,58 +7,79 @@ assignees: ''
77

88
---
99

10-
System Context: [Which system/subsystem this case addresses and its position in the larger system architecture]
10+
[Case writing rules:
11+
- Product Focus: Define agent value and experience, not technical implementation
12+
- Agent Priority: List agents by % importance with Human/System distinction (even if similar to other cases)
13+
- Target System Clarity: Explicitly identify target system and distinguish from consumer/dependency systems
14+
- System Boundaries: Explicitly state what's included/excluded from this case
15+
- Basic English: Write for non-native speakers, avoid complex technical terms
16+
- Scope Limit: Target 3-6 month achievable milestones only
17+
- Agent-Driven: Focus on agent behavior and adoption, not system performance]
1118

12-
## Problem Statement
13-
[Describe the problem from the stakeholder's perspective. What current state needs to change and why? Leave technical details for `hypoteses`.]
19+
## Target System
20+
21+
[Which system this case addresses and its position in the larger system architecture]
1422

15-
### Current State
23+
## Problem Statement
24+
[Describe the agent/business problem this case solves. What current state needs to change and why? Focus on WHAT agents need and WHY it matters. Leave technical details for `hypoteses` of experiments.]
1625

17-
[What exists today]
26+
### Current Agent Experience
1827

19-
### Desired State
28+
[What agents experience today that needs improvement]
2029

21-
[What we want to achieve]
30+
### Desired Agent Experience
2231

23-
### Gap
32+
[What agents should be able to do after this case is complete]
2433

25-
[What's missing or broken]
2634

2735
## Value Proposition
2836

29-
[Clearly articulate the value this case will deliver to the organization and stakeholders]
37+
[Clear business/agent value this case provides]
3038

31-
## Stakeholder Analysis
39+
## Agent Analysis
3240

33-
[Map all stakeholders with their roles, interests, and influence on the system]
41+
[Map all agents (human and system) by priority with percentages. Focus on WHO/WHAT will interact with or benefit from the Target System.]
42+
**Agent Priority Overview**: [e.g., "Primary: 60% Developers, Secondary: 30% Monitoring Systems, Minimal: 10% End Users"]
43+
[Optional: Include not only percentages but also evaluation/justification for why these priorities make sense for this case]
3444

35-
**[Actor 1]**
36-
Role:
37-
Interest/Goal:
38-
Influence Level: [High/Medium/Low]
39-
[How they measure success]
45+
### [Primary Agent Name] ([X%] - Primary)
46+
- **Agent Type**: [Human Agent: role/persona] OR [System Agent: system type/function]
47+
- **Current Pain Points**: [What problems they have today with existing systems]
48+
- **Desired Outcomes**: [What success looks like for them]
49+
- **Agent Journey**: [Action][Action][Successful Outcome]
50+
- **Success Metrics**: [How they measure success - can include system metrics for System Agents]
51+
- **Integration Requirements**: [For System Agents: APIs, data formats, protocols needed]
4052

41-
**[Actor 2]**
42-
Role:
43-
Interest/Goal:
44-
Influence Level: [High/Medium/Low]
45-
[How they measure success]
53+
### [Secondary Agent Name] ([Y%] - Secondary)
54+
[Same structure as above]
4655

47-
## Expected Behaviors & Acceptance
48-
[BDD scenarios that define both the expected system behavior and the acceptance criteria]
56+
[Continue pattern for all Agents, ordered by priority]
4957

50-
### Primary Happy Path
58+
## Expected Agent Experience & Acceptance
59+
[BDD scenarios that define both the Target System behavior and the acceptance criteria. Describe what agents will experience, NOT how the Target System works internally. Focus on acceptance testing, not repeating desired outcomes already listed in Agent Analysis. Validation priorities derive from Agent Priority Overview above - no separate priority statement needed here]
5160

52-
Given [Initial system state and context]
53-
When [Stakeholder performs action]
54-
Then [Expected system response and outcome]
55-
And [Additional expected behaviors]
61+
### Agent Acceptance Scenarios
62+
**Scenario 1: [Primary Happy Path for Human Agent]**
63+
- Given [agent context/starting point]
64+
- When [agent performs action]
65+
- Then [agent experiences result]
66+
- And [additional agent benefit]
5667

5768
**Acceptance Criteria:**
69+
[It would be preferable if non-developers can verify this work in 5-10 minutes]
5870
- [ ] [Specific measurable criterion for this scenario]
5971
- [ ] [Performance/quality requirement for this behavior]
6072

61-
### Alternative Path
73+
**Scenario 2: [Primary Happy Path for System Agent]**
74+
- Given [system agent needs specific data/functionality]
75+
- When [system agent makes API call/integration request]
76+
- Then [target system provides required response/data]
77+
- And [system agent can successfully complete its function]
78+
79+
**Acceptance Criteria:**
80+
[How to verify system agent integration works, e.g. API tests, data format checks]
81+
82+
**Scenario 3: [Alternative Path]**
6283

6384
Given [Different initial conditions]
6485
When [Alternative stakeholder action]
@@ -67,7 +88,7 @@ Then [Expected alternative response]
6788
**Acceptance Criteria:**
6889
- [ ] [Specific measurable criterion for this scenario]
6990

70-
### Error/Edge Case:
91+
**Scenario 4: [Error/Edge Case Handling]**
7192

7293
Given [Error conditions]
7394
When [Action that triggers error]
@@ -78,11 +99,11 @@ Then [Expected error handling behavior]
7899

79100
## System Context & Boundaries
80101

81-
### System Scope
102+
### Target System Scope
82103

83-
In Scope: [What the system will do and boundaries included]
104+
In Scope: [What the Target System will do and boundaries included]
84105
Out of Scope: [What explicitly won't be addressed]
85-
Interfaces: [External systems, data flows, and dependencies]
106+
Interfaces: [External systems (consumer systems, dependency systems, peer/interacting systems), data flows, and dependencies.]
86107

87108
### Quality Attributes
88109

@@ -109,10 +130,7 @@ Owner: [Responsible person]
109130
## Decision Log
110131
[Record key architectural and design decisions]
111132

112-
Date: [Date]
113-
Decision: [Decision made]
114-
Rationale: [Why this decision]
115-
Impact: [What it affects]
133+
[Date] - [Decision] - [Rationale] - [Impact on agents]
116134
Status: [Active/Superseded]
117135

118136
## Learning Outcomes
@@ -128,3 +146,15 @@ Unexpected discoveries:
128146

129147
Process improvements:
130148
Technical approach changes:
149+
150+
151+
[
152+
Final Checklist Before Submitting:
153+
- [ ] Does this describe Agent value, not technical implementation?
154+
- [ ] Are agents prioritized with clear percentages and Human/System distinction?
155+
- [ ] Is the Target System clearly identified and distinguished from consumer/dependency systems?
156+
- [ ] Are system boundaries clearly defined?
157+
- [ ] Is the language simple enough for non-native speakers?
158+
- [ ] Is the scope limited to 3-6 months of achievable work?
159+
- [ ] Do scenarios focus on agent behavior, not system performance?
160+
]

0 commit comments

Comments
 (0)