Skip to content

Commit c7277a3

Browse files
AlexLgnAlexLgn
authored
Merge pull request #352 from TriplEight/3x8_exp_issue_templates
move from acceptance to behavior
2 parents 82dd1fc + 1c98e2c commit c7277a3

File tree

2 files changed

+288
-49
lines changed

2 files changed

+288
-49
lines changed

‎.github/ISSUE_TEMPLATE/case.md‎

Lines changed: 155 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -1,39 +1,170 @@
11
---
22
name: Case
3-
about: High-level R&D goal
4-
title: ''
5-
labels: ''
3+
about: Product-level description in stakeholder language - defines system boundaries and value propositions
4+
title: '[CASE] [Brief descriptive title]'
5+
labels: 'case'
66
assignees: ''
77

88
---
99

10-
[Provide a concise description of the case, including its context and significance to the project]
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 achievable milestones of 3–6 months only
17+
- Agent-Driven: Focus on agent behaviour and adoption, rather than system performance]
1118

12-
## Objectives
13-
- [Objective 1]
14-
- [Objective 2]
15-
- [Objective 3]
19+
## Target System
1620

17-
## Acceptance Criteria
18-
- [ ] [Criterion 1]
19-
- [ ] [Criterion 2]
20-
- [ ] [Criterion 3]
21+
[Which system does this case address and what is its position in the larger system architecture?]
2122

22-
## Related Work
23-
- [Link to related cases, experiments, or tasks]
24-
- [Link to relevant documentation or research]
23+
## Problem Statement
2524

26-
## Constraints
27-
- [List any known constraints or limitations]
25+
[Describe the agent/business problem this case solves. What needs to change in the current state and why? Focus on WHAT agents need and WHY it matters. Leave technical details for `hypotheses` of experiments]
2826

29-
## Risks
30-
- [Identify potential risks and their impact]
27+
### Current Agent Experience
3128

32-
## Learning Outcomes
33-
[To be filled during and after case completion]
29+
[What agents experience today that needs improvement]
30+
31+
### Desired Agent Experience
32+
33+
[What agents should be able to do after this case is complete]
34+
35+
## Value Proposition
36+
37+
[Clear business / agent value that this case provides]
38+
39+
## Agent Analysis
40+
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 an evaluation / justification for why these priorities make sense for this case]
44+
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 do 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]
52+
53+
### [Secondary Agent Name] ([Y%] - Secondary)
54+
55+
[Same structure as above]
56+
57+
[Continue the pattern for all Agents, ordered by priority]
58+
59+
## Expected Agent Experience & Acceptance
60+
61+
[BDD scenarios that define both the Target System behaviour and the acceptance criteria. Describe what agents will experience, NOT how the Target System works internally. Focus on acceptance testing, not repeating the desired outcomes already listed in Agent Analysis. Validation priorities are derived from Agent Priority Overview above – no separate priority statement needed here]
62+
63+
### Agent Acceptance Scenarios
64+
**Scenario 1: [Primary Happy Path for Human Agent]**
65+
- Given [agent context / starting point]
66+
- When [agent performs action]
67+
- Then [agent experiences result]
68+
- And [additional agent benefit]
69+
70+
**Acceptance Criteria:**
71+
72+
[It would be preferable if non-developers can verify this work in 5-10 minutes]
73+
- [ ] [Specific measurable criterion for this scenario]
74+
- [ ] [Performance / quality requirement for this behavior]
75+
76+
**Scenario 2: [Primary Happy Path for System Agent]**
77+
78+
- Given [system agent needs specific data / functionality]
79+
- When [system agent makes API call / integration request]
80+
- Then [target system provides required response / data]
81+
- And [system agent can successfully complete its function]
82+
83+
**Acceptance Criteria:**
84+
85+
[How to verify system agent integration works, e.g. API tests, data format checks]
86+
87+
**Scenario 3: [Alternative Path]**
88+
89+
Given [Different initial conditions]
90+
When [Alternative stakeholder action]
91+
Then [Expected alternative response]
92+
93+
**Acceptance Criteria:**
94+
95+
- [ ] [Specific measurable criterion for this scenario]
96+
97+
**Scenario 4: [Error/Edge Case Handling]**
98+
99+
Given [Error conditions]
100+
When [Action that triggers error]
101+
Then [Expected error handling behavior]
102+
103+
**Acceptance Criteria:**
104+
105+
- [ ] [Specific measurable criterion for error handling]
106+
107+
## System Context & Boundaries
108+
109+
### Target System Scope
110+
111+
In Scope: [What the Target System will do and the boundaries included]
112+
Out of Scope: [What explicitly will not be addressed]
113+
Interfaces: [External systems (consumer systems, dependency systems, peer / interacting systems), data flows, and dependencies]
114+
115+
### Quality Attributes
116+
117+
Performance: [Response time, throughput requirements]
118+
Scalability: [Growth expectations and constraints]
119+
Reliability: [Uptime, error rate expectations]
120+
Security: [Security requirements and compliance needs]
121+
Usability: [User experience requirements]
122+
123+
### Constraints & Dependencies:
124+
125+
Dependencies: [External dependencies and other cases / systems this depends on]
126+
Technical Constraints: [Technical limitations and requirements]
127+
Business Constraints: [Business rules, resource, and timeline constraints]
128+
129+
## Risks Assessment
130+
131+
**[Risk 1]**
132+
133+
Impact: [High / Med / Low]
134+
Probability: [High / Med / Low]
135+
Mitigation Strategy: [Mitigation approach]
136+
Owner: [Responsible person]
34137

35138
## Decision Log
36-
[Record key decisions made during the case]
37139

38-
## Notes
39-
[Any additional information or context]
140+
[Record key architectural and design decisions]
141+
142+
[Date] - [Decision] - [Rationale] - [Impact on agents]
143+
Status: [Active/Superseded]
144+
145+
## Learning Outcomes
146+
147+
[To be filled in during and after the case has been completed]
148+
149+
**What we learned:**
150+
151+
Key insights gained:
152+
Assumptions validated/invalidated:
153+
Unexpected discoveries:
154+
155+
**What we would do differently:**
156+
157+
Process improvements:
158+
Technical approach changes:
159+
160+
161+
[
162+
**Final Checklist Before Submitting:**
163+
- [ ] Does this describe Agent value, not technical implementation?
164+
- [ ] Are agents prioritized with clear percentages and Human / System distinction?
165+
- [ ] Is the Target System clearly identified and distinguished from consumer / dependency systems?
166+
- [ ] Are system boundaries clearly defined?
167+
- [ ] Is the language simple enough for non-native speakers?
168+
- [ ] Is the scope limited to 3-6 months of achievable work?
169+
- [ ] Do scenarios focus on agent behavior, not system performance?
170+
]

‎.github/ISSUE_TEMPLATE/experiment.md‎

Lines changed: 133 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -1,44 +1,152 @@
11
---
22
name: Experiment
3-
about: A tangible part of a case study, to be broken down into engineering tasks
4-
title: ''
5-
labels: ''
3+
about: Engineering-level testable statement that validates part of a case
4+
title: '[EXPERIMENT] [Brief descriptive title]'
5+
labels: 'experiment'
66
assignees: ''
77

88
---
99

10-
## Hypothesis
11-
[State the hypothesis being tested]
10+
## Hypothesis Statement
1211

13-
## Description
14-
[Provide a detailed description of the experiment and its purpose]
12+
We believe that [what we believe to be true]
13+
Will result in [expected outcome]
14+
As evidenced by [measurable signal]
1515

16-
## Methodology
17-
1. [Step 1]
18-
2. [Step 2]
19-
3. [Step 3]
16+
## System Context
2017

21-
## Expected Outcomes
22-
- [Outcome 1]
23-
- [Outcome 2]
18+
System Level: [Module / Interface / Integration / End-to-End]
19+
Component: [Specific system component being tested]
20+
Architecture Layer: [Presentation / Business / Data / Infrastructure]
2421

25-
## Success Criteria
26-
- [ ] [Criterion 1]
27-
- [ ] [Criterion 2]
22+
## Detailed Description
2823

29-
## Resources Required
30-
- [Resource 1]
31-
- [Resource 2]
24+
[Provide engineering-level detail about what specific aspect of the system this hypothesis tests]
3225

33-
## Risks and Mitigation
34-
- Risk: [Describe risk]
35-
Mitigation: [Describe mitigation strategy]
26+
**Technical Scope:**
27+
28+
[What technical aspects are being validated]
29+
[Which system components are involved]
30+
[What interfaces or integrations are tested]
31+
32+
## Experimental Design
33+
34+
### Setup Requirements
35+
36+
**Environment:**
37+
38+
[Development / Testing / Production-like environment needs]
39+
[Specific configuration requirements]
40+
41+
**Data Requirements:**
42+
43+
[Test data needed]
44+
[Data volume and characteristics]
45+
46+
**Tool Requirements:**
47+
48+
[Measurement and monitoring tools]
49+
[Testing frameworks and utilities]
50+
51+
### Test Methodology
52+
53+
Approach: [Controlled experiment / A-B test / Spike / Prototype / etc.]
54+
55+
**Steps:**
56+
57+
1. [Detailed step with expected outcome]
58+
2. [Detailed step with expected outcome]
59+
3. [Detailed step with expected outcome]
60+
61+
**Variables:**
62+
63+
Independent Variables: [What we're changing]
64+
Dependent Variables: [What we're measuring]
65+
Control Variables: [What we're keeping constant]
66+
67+
## Expected Outcomes & Validation
68+
69+
**Expected Results:**
70+
71+
- Key metric 1: [Expected range / value]
72+
- Key metric 2: [Expected range / value]
73+
74+
**Validation Criteria:**
75+
76+
- [ ] Hypothesis Confirmed If: [Specific measurable criterion]
77+
- [ ] Hypothesis Rejected If: [Specific measurable criterion]
78+
- [ ] Inconclusive If: [Conditions requiring further investigation]
79+
80+
## Resources & Constraints
81+
82+
**Required Resources:**
83+
84+
Human: [Roles needed and time commitment]
85+
Technical: [Computing resources, environments, tools, licenses]
86+
Timeline: [Estimated duration for setup, execution, analysis]
87+
88+
**Risks & Mitigation:**
89+
90+
**[Risk 1]**
91+
92+
System Impact: [System impact]
93+
Probability: [High / Med / Low]
94+
Mitigation Strategy: [Prevention]
95+
Rollback plan: [Recovery]
3696

3797
## Results
98+
3899
[To be filled after experiment completion]
39100

40-
## Learnings
101+
**Data Collected:**
102+
103+
[Actual measurements and observations]
104+
105+
**Analysis:**
106+
107+
[Statistical analysis, trend analysis]
108+
109+
**Conclusion:**
110+
111+
[Hypothesis confirmed / rejected / inconclusive]
112+
[Confidence level in results]
113+
114+
## Learnings and Insights
115+
41116
[To be filled after experiment completion]
42117

118+
**Technical Learnings:**
119+
120+
[What we learned about the system]
121+
[Unexpected technical discoveries]
122+
123+
**Process Learnings:**
124+
125+
[What we learned about our experimental approach]
126+
[Improvements for future hypotheses]
127+
128+
## Impact on Parent Case
129+
130+
[How these results affect the parent case and its acceptance criteria]
131+
132+
**Case Progression:**
133+
134+
[How this moves the case forward]
135+
[What case assumptions were validated / invalidated]
136+
43137
## Next Steps
44-
[To be determined based on results]
138+
139+
**If Hypothesis Confirmed:**
140+
141+
- [ ] [Specific next actions]
142+
- [ ] [Additional hypotheses to test]
143+
144+
**If Hypothesis Rejected:**
145+
146+
- [ ] [Alternative approaches to investigate]
147+
- [ ] [Case pivot considerations]
148+
149+
**If Inconclusive:**
150+
151+
- [ ] [Additional experiments needed]
152+
- [ ] [Refinements to experimental design]

0 commit comments

Comments
 (0)