@mark-gozner/aigile-method 0.4.5
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE.md +26 -0
- package/README.md +300 -0
- package/core/agent-teams/team-all.yaml +24 -0
- package/core/agent-teams/team-company.yaml +17 -0
- package/core/agent-teams/team-enterprise.yaml +17 -0
- package/core/agent-teams/team-fullstack.yaml +16 -0
- package/core/agent-teams/team-ide-minimal.yaml +10 -0
- package/core/agents/aigile-master.md +476 -0
- package/core/agents/aigile-orchestrator.agent.md +200 -0
- package/core/agents/analyst.md +45 -0
- package/core/agents/architect.md +43 -0
- package/core/agents/code-tour.agent.md +208 -0
- package/core/agents/dev.agent.md +145 -0
- package/core/agents/dev.md +130 -0
- package/core/agents/expert-react-frontend-engineer.agent.md +741 -0
- package/core/agents/pm.md +33 -0
- package/core/agents/po.md +35 -0
- package/core/agents/qa.md +38 -0
- package/core/agents/sm.md +31 -0
- package/core/agents/ui-expert.md +39 -0
- package/core/agents/ux-expert.md +31 -0
- package/core/checklists/architect-checklist.md +246 -0
- package/core/checklists/change-checklist.md +182 -0
- package/core/checklists/pm-checklist.md +286 -0
- package/core/checklists/po-master-checklist.md +291 -0
- package/core/checklists/story-dod-checklist.md +94 -0
- package/core/checklists/story-draft-checklist.md +153 -0
- package/core/core-config.yaml +22 -0
- package/core/data/aigile-kb.md +112 -0
- package/core/data/brainstorming-techniques.md +73 -0
- package/core/data/elicitation-methods.md +42 -0
- package/core/data/technical-preferences.md +52 -0
- package/core/data/test-levels-framework.md +43 -0
- package/core/data/test-priorities-matrix.md +26 -0
- package/core/instructions/csharp.instructions.md +656 -0
- package/core/instructions/dotnet/csharp.instructions.md +656 -0
- package/core/instructions/java/java.instructions.md +67 -0
- package/core/instructions/java/spring-boot.instructions.md +122 -0
- package/core/instructions/java.instructions.md +67 -0
- package/core/instructions/spring-boot.instructions.md +122 -0
- package/core/prompts/README.md +11 -0
- package/core/prompts/architecture/architecture-blueprint-generator.prompt.md +322 -0
- package/core/prompts/architecture/architecture-validation.prompt.md +71 -0
- package/core/prompts/architecture/file-tree-generator.prompt.md +405 -0
- package/core/prompts/architecture/technical-project-analyze.prompt.md +43 -0
- package/core/prompts/architecture-blueprint-generator.prompt.md +322 -0
- package/core/prompts/architecture-validation.prompt.md +71 -0
- package/core/prompts/code-review.prompt.md +107 -0
- package/core/prompts/confluence-in-md.prompt.md +167 -0
- package/core/prompts/copilot-instructions-blueprint-generator.prompt.md +294 -0
- package/core/prompts/create-implementation-plan.prompt.md +157 -0
- package/core/prompts/create-oo-component-documentation.prompt.md +193 -0
- package/core/prompts/file-tree-generator.prompt.md +405 -0
- package/core/prompts/generate-unit-tests.prompt.md +291 -0
- package/core/prompts/java/java-doc.prompt.md +24 -0
- package/core/prompts/java/java-junit.prompt.md +64 -0
- package/core/prompts/java/junit-5.prompt.md +64 -0
- package/core/prompts/java-doc.prompt.md +24 -0
- package/core/prompts/java-junit.prompt.md +64 -0
- package/core/prompts/junit-5.prompt.md +64 -0
- package/core/prompts/release-notes/README.md +11 -0
- package/core/prompts/release-notes/release-notes.prompt.md +723 -0
- package/core/prompts/release-notes.prompt.md +723 -0
- package/core/prompts/technical-project-analyze.prompt.md +43 -0
- package/core/tasks/advanced-elicitation.md +119 -0
- package/core/tasks/check-story-implemented.md +44 -0
- package/core/tasks/code-arch-review-with-github.md +40 -0
- package/core/tasks/create-architecture-doc.md +55 -0
- package/core/tasks/create-jira-epic-from-confluence.md +70 -0
- package/core/tasks/create-jira-story-from-confluence.md +39 -0
- package/core/tasks/create-jira-story-from-text.md +39 -0
- package/core/tasks/create-next-story.md +35 -0
- package/core/tasks/create-prd-doc.md +54 -0
- package/core/tasks/create-stories-from-epic.md +66 -0
- package/core/tasks/create-tasks-for-story.md +60 -0
- package/core/tasks/document-project.md +69 -0
- package/core/tasks/execute-checklist.md +37 -0
- package/core/tasks/explain-story-from-jira.md +44 -0
- package/core/tasks/facilitate-brainstorming-session.md +69 -0
- package/core/tasks/figma-audit-design-system.md +20 -0
- package/core/tasks/front-end-spec-from-design.md +33 -0
- package/core/tasks/gate.md +64 -0
- package/core/tasks/groom-jira-story.md +52 -0
- package/core/tasks/help.md +27 -0
- package/core/tasks/implement-freeform-work-item.md +30 -0
- package/core/tasks/implement-story-from-jira.md +63 -0
- package/core/tasks/implement-unit-tests.md +45 -0
- package/core/tasks/market-research-from-context7.md +37 -0
- package/core/tasks/review-story.md +30 -0
- package/core/tasks/sonarqube-hotspot-review.md +39 -0
- package/core/tasks/standup-digest.md +21 -0
- package/core/tasks/sync-jira-backlog.md +32 -0
- package/core/tasks/test-design.md +68 -0
- package/core/tasks/validate-next-story.md +37 -0
- package/core/tasks/verify-jira-story-e2e.md +45 -0
- package/core/templates/architecture-tmpl.yaml +651 -0
- package/core/templates/brainstorming-output-tmpl.yaml +156 -0
- package/core/templates/brownfield-architecture-tmpl.yaml +477 -0
- package/core/templates/brownfield-prd-tmpl.yaml +281 -0
- package/core/templates/front-end-architecture-tmpl.yaml +219 -0
- package/core/templates/front-end-spec-tmpl.yaml +350 -0
- package/core/templates/fullstack-architecture-tmpl.yaml +824 -0
- package/core/templates/market-research-tmpl.yaml +253 -0
- package/core/templates/prd-tmpl.yaml +203 -0
- package/core/templates/project-brief-tmpl.yaml +222 -0
- package/core/templates/qa-gate-tmpl.yaml +103 -0
- package/core/templates/story-tmpl.yaml +138 -0
- package/core/workflows/brownfield-fullstack.yaml +298 -0
- package/core/workflows/brownfield-service.yaml +188 -0
- package/core/workflows/brownfield-ui.yaml +198 -0
- package/core/workflows/greenfield-fullstack.yaml +241 -0
- package/core/workflows/greenfield-service.yaml +207 -0
- package/core/workflows/greenfield-ui.yaml +236 -0
- package/dist/agents/aigile-master.txt +500 -0
- package/dist/agents/aigile-orchestrator.agent.txt +224 -0
- package/dist/agents/analyst.txt +69 -0
- package/dist/agents/architect.txt +67 -0
- package/dist/agents/code-tour.agent.txt +232 -0
- package/dist/agents/dev.agent.txt +169 -0
- package/dist/agents/dev.txt +154 -0
- package/dist/agents/expert-react-frontend-engineer.agent.txt +765 -0
- package/dist/agents/pm.txt +57 -0
- package/dist/agents/po.txt +59 -0
- package/dist/agents/qa.txt +62 -0
- package/dist/agents/sm.txt +55 -0
- package/dist/agents/ui-expert.txt +63 -0
- package/dist/agents/ux-expert.txt +55 -0
- package/dist/dev-agent-bundle.txt +154 -0
- package/dist/teams/team-company.txt +10789 -0
- package/docs/mcp-servers.md +102 -0
- package/docs/orchestrator-guide.md +526 -0
- package/mcp/servers.json +108 -0
- package/mcp/servers.yaml +124 -0
- package/package.json +72 -0
- package/tools/cli.js +1864 -0
- package/tools/installer/README.md +24 -0
- package/tools/installer/lib/ide-setup.js +295 -0
- package/tools/installer/lib/installer.js +131 -0
- package/tools/md-assets/web-agent-startup-instructions.md +21 -0
- package/tools/postinstall.js +72 -0
- package/tools/shared/bannerArt.js +68 -0
- package/tools/validate-bundles.js +54 -0
- package/tools/verify-publish-registry.js +34 -0
|
@@ -0,0 +1,153 @@
|
|
|
1
|
+
# Story Draft Checklist
|
|
2
|
+
|
|
3
|
+
The Product Owner should use this checklist to validate that each story contains sufficient context for a developer agent to implement it successfully, while assuming the dev agent has reasonable capabilities to figure things out.
|
|
4
|
+
|
|
5
|
+
[[LLM: INITIALIZATION INSTRUCTIONS - STORY DRAFT VALIDATION
|
|
6
|
+
|
|
7
|
+
Before proceeding with this checklist, ensure you have access to:
|
|
8
|
+
|
|
9
|
+
1. The story document being validated (usually in docs/stories/ or provided directly)
|
|
10
|
+
2. The parent epic context
|
|
11
|
+
3. Any referenced architecture or design documents
|
|
12
|
+
4. Previous related stories if this builds on prior work
|
|
13
|
+
|
|
14
|
+
IMPORTANT: This checklist validates individual stories BEFORE implementation begins.
|
|
15
|
+
|
|
16
|
+
VALIDATION PRINCIPLES:
|
|
17
|
+
|
|
18
|
+
1. Clarity - A developer should understand WHAT to build
|
|
19
|
+
2. Context - WHY this is being built and how it fits
|
|
20
|
+
3. Guidance - Key technical decisions and patterns to follow
|
|
21
|
+
4. Testability - How to verify the implementation works
|
|
22
|
+
5. Self-Contained - Most info needed is in the story itself
|
|
23
|
+
|
|
24
|
+
REMEMBER: We assume competent developer agents who can:
|
|
25
|
+
|
|
26
|
+
- Research documentation and codebases
|
|
27
|
+
- Make reasonable technical decisions
|
|
28
|
+
- Follow established patterns
|
|
29
|
+
- Ask for clarification when truly stuck
|
|
30
|
+
|
|
31
|
+
We're checking for SUFFICIENT guidance, not exhaustive detail.]]
|
|
32
|
+
|
|
33
|
+
## 1. GOAL & CONTEXT CLARITY
|
|
34
|
+
|
|
35
|
+
[[LLM: Without clear goals, developers build the wrong thing. Verify:
|
|
36
|
+
|
|
37
|
+
1. The story states WHAT functionality to implement
|
|
38
|
+
2. The business value or user benefit is clear
|
|
39
|
+
3. How this fits into the larger epic/product is explained
|
|
40
|
+
4. Dependencies are explicit ("requires Story X to be complete")
|
|
41
|
+
5. Success looks like something specific, not vague]]
|
|
42
|
+
|
|
43
|
+
- [ ] Story goal/purpose is clearly stated
|
|
44
|
+
- [ ] Relationship to epic goals is evident
|
|
45
|
+
- [ ] How the story fits into overall system flow is explained
|
|
46
|
+
- [ ] Dependencies on previous stories are identified (if applicable)
|
|
47
|
+
- [ ] Business context and value are clear
|
|
48
|
+
|
|
49
|
+
## 2. TECHNICAL IMPLEMENTATION GUIDANCE
|
|
50
|
+
|
|
51
|
+
[[LLM: Developers need enough technical context to start coding. Check:
|
|
52
|
+
|
|
53
|
+
1. Key files/components to create or modify are mentioned
|
|
54
|
+
2. Technology choices are specified where non-obvious
|
|
55
|
+
3. Integration points with existing code are identified
|
|
56
|
+
4. Data models or API contracts are defined or referenced
|
|
57
|
+
5. Non-standard patterns or exceptions are called out
|
|
58
|
+
|
|
59
|
+
Note: We don't need every file listed - just the important ones.]]
|
|
60
|
+
|
|
61
|
+
- [ ] Key files to create/modify are identified (not necessarily exhaustive)
|
|
62
|
+
- [ ] Technologies specifically needed for this story are mentioned
|
|
63
|
+
- [ ] Critical APIs or interfaces are sufficiently described
|
|
64
|
+
- [ ] Necessary data models or structures are referenced
|
|
65
|
+
- [ ] Required environment variables are listed (if applicable)
|
|
66
|
+
- [ ] Any exceptions to standard coding patterns are noted
|
|
67
|
+
|
|
68
|
+
## 3. REFERENCE EFFECTIVENESS
|
|
69
|
+
|
|
70
|
+
[[LLM: References should help, not create a treasure hunt. Ensure:
|
|
71
|
+
|
|
72
|
+
1. References point to specific sections, not whole documents
|
|
73
|
+
2. The relevance of each reference is explained
|
|
74
|
+
3. Critical information is summarized in the story
|
|
75
|
+
4. References are accessible (not broken links)
|
|
76
|
+
5. Previous story context is summarized if needed]]
|
|
77
|
+
|
|
78
|
+
- [ ] References to external documents point to specific relevant sections
|
|
79
|
+
- [ ] Critical information from previous stories is summarized (not just referenced)
|
|
80
|
+
- [ ] Context is provided for why references are relevant
|
|
81
|
+
- [ ] References use consistent format (e.g., `docs/filename.md#section`)
|
|
82
|
+
|
|
83
|
+
## 4. SELF-CONTAINMENT ASSESSMENT
|
|
84
|
+
|
|
85
|
+
[[LLM: Stories should be mostly self-contained to avoid context switching. Verify:
|
|
86
|
+
|
|
87
|
+
1. Core requirements are in the story, not just in references
|
|
88
|
+
2. Domain terms are explained or obvious from context
|
|
89
|
+
3. Assumptions are stated explicitly
|
|
90
|
+
4. Edge cases are mentioned (even if deferred)
|
|
91
|
+
5. The story could be understood without reading 10 other documents]]
|
|
92
|
+
|
|
93
|
+
- [ ] Core information needed is included (not overly reliant on external docs)
|
|
94
|
+
- [ ] Implicit assumptions are made explicit
|
|
95
|
+
- [ ] Domain-specific terms or concepts are explained
|
|
96
|
+
- [ ] Edge cases or error scenarios are addressed
|
|
97
|
+
|
|
98
|
+
## 5. TESTING GUIDANCE
|
|
99
|
+
|
|
100
|
+
[[LLM: Testing ensures the implementation actually works. Check:
|
|
101
|
+
|
|
102
|
+
1. Test approach is specified (unit, integration, e2e)
|
|
103
|
+
2. Key test scenarios are listed
|
|
104
|
+
3. Success criteria are measurable
|
|
105
|
+
4. Special test considerations are noted
|
|
106
|
+
5. Acceptance criteria in the story are testable]]
|
|
107
|
+
|
|
108
|
+
- [ ] Required testing approach is outlined
|
|
109
|
+
- [ ] Key test scenarios are identified
|
|
110
|
+
- [ ] Success criteria are defined
|
|
111
|
+
- [ ] Special testing considerations are noted (if applicable)
|
|
112
|
+
|
|
113
|
+
## VALIDATION RESULT
|
|
114
|
+
|
|
115
|
+
[[LLM: FINAL STORY VALIDATION REPORT
|
|
116
|
+
|
|
117
|
+
Generate a concise validation report:
|
|
118
|
+
|
|
119
|
+
1. Quick Summary
|
|
120
|
+
- Story readiness: READY / NEEDS REVISION / BLOCKED
|
|
121
|
+
- Clarity score (1-10)
|
|
122
|
+
- Major gaps identified
|
|
123
|
+
|
|
124
|
+
2. Fill in the validation table with:
|
|
125
|
+
- PASS: Requirements clearly met
|
|
126
|
+
- PARTIAL: Some gaps but workable
|
|
127
|
+
- FAIL: Critical information missing
|
|
128
|
+
|
|
129
|
+
3. Specific Issues (if any)
|
|
130
|
+
- List concrete problems to fix
|
|
131
|
+
- Suggest specific improvements
|
|
132
|
+
- Identify any blocking dependencies
|
|
133
|
+
|
|
134
|
+
4. Developer Perspective
|
|
135
|
+
- Could YOU implement this story as written?
|
|
136
|
+
- What questions would you have?
|
|
137
|
+
- What might cause delays or rework?
|
|
138
|
+
|
|
139
|
+
Be pragmatic - perfect documentation doesn't exist, but it must be enough to provide the extreme context a dev agent needs to get the work down and not create a mess.]]
|
|
140
|
+
|
|
141
|
+
| Category | Status | Issues |
|
|
142
|
+
| ------------------------------------ | ------ | ------ |
|
|
143
|
+
| 1. Goal & Context Clarity | _TBD_ | |
|
|
144
|
+
| 2. Technical Implementation Guidance | _TBD_ | |
|
|
145
|
+
| 3. Reference Effectiveness | _TBD_ | |
|
|
146
|
+
| 4. Self-Containment Assessment | _TBD_ | |
|
|
147
|
+
| 5. Testing Guidance | _TBD_ | |
|
|
148
|
+
|
|
149
|
+
**Final Assessment:**
|
|
150
|
+
|
|
151
|
+
- READY: The story provides sufficient context for implementation
|
|
152
|
+
- NEEDS REVISION: The story requires updates (see issues)
|
|
153
|
+
- BLOCKED: External information required (specify what information)
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
markdownExploder: true
|
|
2
|
+
qa:
|
|
3
|
+
qaLocation: docs/qa
|
|
4
|
+
prd:
|
|
5
|
+
prdFile: docs/prd.md
|
|
6
|
+
prdVersion: v1
|
|
7
|
+
prdSharded: true
|
|
8
|
+
prdShardedLocation: docs/prd
|
|
9
|
+
epicFilePattern: epic-{n}*.md
|
|
10
|
+
architecture:
|
|
11
|
+
architectureFile: docs/architecture.md
|
|
12
|
+
architectureVersion: v1
|
|
13
|
+
architectureSharded: true
|
|
14
|
+
architectureShardedLocation: docs/architecture
|
|
15
|
+
customTechnicalDocuments: null
|
|
16
|
+
devLoadAlwaysFiles:
|
|
17
|
+
- docs/architecture/coding-standards.md
|
|
18
|
+
- docs/architecture/tech-stack.md
|
|
19
|
+
- docs/architecture/source-tree.md
|
|
20
|
+
devDebugLog: .ai/debug-log.md
|
|
21
|
+
devStoryLocation: docs/stories
|
|
22
|
+
slashPrefix: aigile
|
|
@@ -0,0 +1,112 @@
|
|
|
1
|
+
<!-- Powered by AIgile™ Core -->
|
|
2
|
+
|
|
3
|
+
# AIgile Knowledge Base
|
|
4
|
+
|
|
5
|
+
## Overview
|
|
6
|
+
|
|
7
|
+
AIgile (AI-assisted Agile Development Method) provides a lean, role-focused agent system, reusable tasks/templates/checklists, and MCP-enabled integrations to deliver software with clear handoffs and strong quality gates.
|
|
8
|
+
|
|
9
|
+
### Key Features
|
|
10
|
+
|
|
11
|
+
- Role-specialized agents (Analyst, PM, PO, Architect, Dev, QA, UX/UI, SM)
|
|
12
|
+
- Reusable resources: tasks, templates, checklists, and data
|
|
13
|
+
- IDE-first flow with optional web bundle for planning
|
|
14
|
+
- MCP-ready: GitHub, Atlassian, SonarQube, Playwright, Memory, Sequential Thinking, Context7
|
|
15
|
+
- Clean dependency mapping for precise, minimal context
|
|
16
|
+
|
|
17
|
+
### When to Use AIgile
|
|
18
|
+
|
|
19
|
+
- Greenfield projects: PRD → Architecture → Stories → Implementation
|
|
20
|
+
- Brownfield work: Document current system → Focused epics/stories → Incremental improvements
|
|
21
|
+
- Team collaboration: Clear per-role workflows and quality checks
|
|
22
|
+
|
|
23
|
+
## How AIgile Works
|
|
24
|
+
|
|
25
|
+
### Core Method
|
|
26
|
+
|
|
27
|
+
You direct specialized agents through executable tasks. Each agent focuses on its discipline, uses declared dependencies only when needed, and hands off work cleanly to the next role.
|
|
28
|
+
|
|
29
|
+
1. You set the goal and provide decisions.
|
|
30
|
+
2. Agents execute via tasks and checklists, loading only referenced dependencies.
|
|
31
|
+
3. Clean, fresh chats between roles preserve context quality.
|
|
32
|
+
|
|
33
|
+
### Two-Phase Approach
|
|
34
|
+
|
|
35
|
+
- Planning (often Web UI): Create PRD/Architecture efficiently; multi-agent ideation and research.
|
|
36
|
+
- Development (IDE): Shard docs, implement stories sequentially, validate with QA before Done.
|
|
37
|
+
|
|
38
|
+
### Development Loop
|
|
39
|
+
|
|
40
|
+
```
|
|
41
|
+
1. SM → create next story from sharded docs
|
|
42
|
+
2. You review/approve
|
|
43
|
+
3. Dev → implement story with tests
|
|
44
|
+
4. QA → review and validate
|
|
45
|
+
5. You verify completion
|
|
46
|
+
6. Repeat
|
|
47
|
+
```
|
|
48
|
+
|
|
49
|
+
### Why This Works
|
|
50
|
+
|
|
51
|
+
- Role clarity and specialization
|
|
52
|
+
- Minimal necessary context at each step
|
|
53
|
+
- Strong gates and explicit acceptance criteria
|
|
54
|
+
|
|
55
|
+
## Getting Started
|
|
56
|
+
|
|
57
|
+
- Web bundle: use `dist/teams/team-company.txt` in large-context web models for planning.
|
|
58
|
+
- IDE install: `aigile install` to copy `.aigile-core`, generate chatmodes, and optional MCP configuration.
|
|
59
|
+
|
|
60
|
+
Required docs: save planning outputs to `docs/prd.md` and `docs/architecture.md`; shard to `docs/prd/` and `docs/architecture/` for development.
|
|
61
|
+
|
|
62
|
+
## Core Configuration
|
|
63
|
+
|
|
64
|
+
`core/core-config.yaml` defines where docs live and what the dev agent should always load (devLoadAlwaysFiles). It enables gradual adoption and custom layouts.
|
|
65
|
+
|
|
66
|
+
## Reusable Resources
|
|
67
|
+
|
|
68
|
+
- Templates: PRD, architecture, story, QA gate, front-end spec
|
|
69
|
+
- Tasks: shard-doc, create-next-story, implement-story-from-jira, test-design, gate
|
|
70
|
+
- Checklists: story DoD, PO master, architect review, change checklist
|
|
71
|
+
- Data: brainstorming techniques, elicitation methods, technical preferences, test levels, test priorities
|
|
72
|
+
|
|
73
|
+
## Agent System (Quick Reference)
|
|
74
|
+
|
|
75
|
+
| Agent | Primary Functions |
|
|
76
|
+
| --- | --- |
|
|
77
|
+
| analyst | brainstorming, research, project documentation |
|
|
78
|
+
| pm | PRD creation, backlog sync, planning |
|
|
79
|
+
| po | story creation, grooming, validation |
|
|
80
|
+
| architect | architecture design/review, ADRs |
|
|
81
|
+
| dev | story implementation, tests, code quality |
|
|
82
|
+
| qa | test design, quality gates, E2E validation |
|
|
83
|
+
| ux/ui | research, journey mapping, design system compliance |
|
|
84
|
+
| sm | story creation, facilitation |
|
|
85
|
+
|
|
86
|
+
## IDE Usage Principles
|
|
87
|
+
|
|
88
|
+
- Use fresh chats when switching roles.
|
|
89
|
+
- Only load dependency files during task execution.
|
|
90
|
+
- Tasks with elicit=true require user interaction.
|
|
91
|
+
- Keep Dev agent lean; planning agents can be richer in web contexts.
|
|
92
|
+
|
|
93
|
+
## Brownfield Guidance (Condensed)
|
|
94
|
+
|
|
95
|
+
- Document first (analyst document-project), then PRD/architecture.
|
|
96
|
+
- Shard docs; implement one story at a time.
|
|
97
|
+
- Emphasize compatibility, migration, and risk mitigation; prefer incremental rollout.
|
|
98
|
+
|
|
99
|
+
## Success Tips
|
|
100
|
+
|
|
101
|
+
- Keep the technical preferences current.
|
|
102
|
+
- Tie AC to test levels and priorities.
|
|
103
|
+
- Maintain decision logs and risks for visibility.
|
|
104
|
+
- Prefer smallest viable change; validate early.
|
|
105
|
+
|
|
106
|
+
## See Also
|
|
107
|
+
|
|
108
|
+
- `core/data/technical-preferences.md`
|
|
109
|
+
- `core/data/test-levels-framework.md`
|
|
110
|
+
- `core/data/test-priorities-matrix.md`
|
|
111
|
+
- `core/data/brainstorming-techniques.md`
|
|
112
|
+
- `core/data/elicitation-methods.md`
|
|
@@ -0,0 +1,73 @@
|
|
|
1
|
+
# Brainstorming Techniques (Company)
|
|
2
|
+
|
|
3
|
+
Clear, time-boxed facilitation patterns your Analyst, PM/PO, and Architect can run. Always capture raw ideas and synthesize outcomes into decisions, risks, and next steps.
|
|
4
|
+
|
|
5
|
+
## How to pick a technique
|
|
6
|
+
- Use Round-robin when you need equal participation with low facilitation overhead.
|
|
7
|
+
- Use Crazy 8s to diverge quickly on UI/flow concepts or solution shapes.
|
|
8
|
+
- Use SCAMPER to systematically transform an existing idea/process.
|
|
9
|
+
- Use Assumption Busting to de-risk bold initiatives or legacy rewrites.
|
|
10
|
+
- Use Worst Idea Wins to surface hidden risks and anti-patterns playfully.
|
|
11
|
+
|
|
12
|
+
## Techniques (numbered for quick reference)
|
|
13
|
+
1) Round-robin ideation
|
|
14
|
+
- Goal: Ensure every voice contributes at least one idea per round.
|
|
15
|
+
- Timebox: 10–20 minutes, 2–3 rounds.
|
|
16
|
+
- Steps:
|
|
17
|
+
1. State the prompt and constraints in one sentence.
|
|
18
|
+
2. Go around the group one by one; each person shares 1 idea (max 30s).
|
|
19
|
+
3. Write all ideas verbatim; no discussion or critique.
|
|
20
|
+
4. After rounds, cluster similar ideas and dot-vote top 3.
|
|
21
|
+
- Outputs: Ranked idea list, clusters/themes, top 3 for refinement.
|
|
22
|
+
|
|
23
|
+
2) Crazy 8s (adapted for product/UX and flows)
|
|
24
|
+
- Goal: Rapid divergence; 8 variations in 8 minutes per person.
|
|
25
|
+
- Timebox: 10–15 minutes ideation + 10 minutes share-out.
|
|
26
|
+
- Steps:
|
|
27
|
+
1. Provide the scenario (e.g., onboarding flow, dashboard layout).
|
|
28
|
+
2. Each participant sketches 8 variations (1 per minute). Bulleted text is fine if sketching isn’t feasible.
|
|
29
|
+
3. 60–90 seconds per person to present their strongest 1–2 variants.
|
|
30
|
+
4. Collect patterns and shortlist 2–3 concepts for prototype/spike.
|
|
31
|
+
- Outputs: Photo/scan of variations, shortlist of concepts, next prototype task.
|
|
32
|
+
|
|
33
|
+
3) SCAMPER prompts (adapted)
|
|
34
|
+
- Substitute, Combine, Adapt, Modify/Magnify/Minify, Put to other uses, Eliminate, Reverse/Rearrange.
|
|
35
|
+
- Timebox: 20–30 minutes.
|
|
36
|
+
- Steps:
|
|
37
|
+
1. Take a current solution or process.
|
|
38
|
+
2. Walk through each SCAMPER lens; generate at least 1 idea per lens.
|
|
39
|
+
3. Mark ideas that reduce complexity/cost or increase user value.
|
|
40
|
+
- Outputs: SCAMPER idea set with annotations on impact/effort.
|
|
41
|
+
|
|
42
|
+
4) Assumption busting
|
|
43
|
+
- Goal: Identify and test risky assumptions early.
|
|
44
|
+
- Timebox: 25–40 minutes.
|
|
45
|
+
- Steps:
|
|
46
|
+
1. List top 10 assumptions underpinning the idea or system.
|
|
47
|
+
2. Score each assumption by impact if wrong (High/Med/Low) and confidence (High/Med/Low).
|
|
48
|
+
3. Target High-impact, Low-confidence assumptions for spikes/experiments.
|
|
49
|
+
- Outputs: Assumption register with experiment/spike backlog.
|
|
50
|
+
|
|
51
|
+
5) Worst idea wins (to surface risks)
|
|
52
|
+
- Goal: Elicit failure modes and anti-patterns safely.
|
|
53
|
+
- Timebox: 15–25 minutes.
|
|
54
|
+
- Steps:
|
|
55
|
+
1. Prompt: “What’s the WORST way to solve this?” Encourage humor.
|
|
56
|
+
2. Extract implicit risks/anti-patterns from the worst ideas.
|
|
57
|
+
3. Convert to mitigations, guardrails, or acceptance criteria.
|
|
58
|
+
- Outputs: Risk list with mitigations and DoD/AC updates.
|
|
59
|
+
|
|
60
|
+
## Facilitator checklist
|
|
61
|
+
- Clarify the single prompt and constraints.
|
|
62
|
+
- Enforce timeboxes strictly; keep critique out during divergence.
|
|
63
|
+
- Capture everything in the raw; synthesize only after divergence.
|
|
64
|
+
- End with decisions, named owners, and next steps.
|
|
65
|
+
|
|
66
|
+
## Anti-patterns to avoid
|
|
67
|
+
- Open-ended sessions without a timebox or a clear prompt.
|
|
68
|
+
- Premature critique shutting down contributions.
|
|
69
|
+
- No synthesis or next steps.
|
|
70
|
+
|
|
71
|
+
## References in this repository
|
|
72
|
+
- Use with Analyst commands: brainstorm, create-project-brief, perform-market-research.
|
|
73
|
+
- See also: `core/data/elicitation-methods.md` for follow-up interviews/workshops.
|
|
@@ -0,0 +1,42 @@
|
|
|
1
|
+
# Elicitation Methods (Company)
|
|
2
|
+
|
|
3
|
+
Field-proven techniques to discover and refine requirements. Pick the lightest method that answers the question; combine as needed.
|
|
4
|
+
|
|
5
|
+
## 1) Stakeholder interviews
|
|
6
|
+
- Use when: Clarifying goals, constraints, success metrics, or hidden requirements.
|
|
7
|
+
- Preparation: Interview guide with top 8–12 questions; consent to record; target roles.
|
|
8
|
+
- Steps:
|
|
9
|
+
1. Open with outcomes and timebox; ask open questions; dig into “why” and “how often”.
|
|
10
|
+
2. Capture quotes and facts; flag assumptions; ask for examples/artifacts.
|
|
11
|
+
3. Close with summary, gaps, and follow-ups.
|
|
12
|
+
- Outputs: Interview notes, risks/assumptions list, decisions and open questions.
|
|
13
|
+
|
|
14
|
+
## 2) Contextual inquiry (on-the-job observation)
|
|
15
|
+
- Use when: Understanding real workflows, tools, and blockers.
|
|
16
|
+
- Steps: Observe tasks, ask “think aloud”, capture artifacts/screens, time pain points.
|
|
17
|
+
- Outputs: As-is workflow, pain points, opportunities, and time-to-task metrics.
|
|
18
|
+
|
|
19
|
+
## 3) Journey mapping
|
|
20
|
+
- Use when: Visualizing end-to-end user experience across touchpoints.
|
|
21
|
+
- Steps: Define persona, stages, actions, feelings, pain points, opportunities.
|
|
22
|
+
- Outputs: Journey map with prioritized opportunities and hypotheses.
|
|
23
|
+
|
|
24
|
+
## 4) Prototyping feedback
|
|
25
|
+
- Use when: Testing concepts cheaply before committing.
|
|
26
|
+
- Steps: Prepare clickable or paper prototype; define tasks; observe success/struggle.
|
|
27
|
+
- Outputs: Findings matrix (what worked/struggled), design decisions, next prototype.
|
|
28
|
+
|
|
29
|
+
## 5) Requirements workshops
|
|
30
|
+
- Use when: Aligning on scope, AC, and definitions across multiple stakeholders.
|
|
31
|
+
- Steps: Timebox; start with goals; draft user stories; define AC using GWT; dot-vote.
|
|
32
|
+
- Outputs: Prioritized stories, AC, open questions, and decision log.
|
|
33
|
+
|
|
34
|
+
## Artifacts to produce
|
|
35
|
+
- Decision log entries
|
|
36
|
+
- Risks and assumptions
|
|
37
|
+
- User stories with AC (GWT)
|
|
38
|
+
- Updated PRD sections
|
|
39
|
+
|
|
40
|
+
## Cross-references in this repository
|
|
41
|
+
- Pair with `core/data/brainstorming-techniques.md` for ideation before/after.
|
|
42
|
+
- Use with PO/Analyst tasks: create-next-story, groom-jira-story.
|
|
@@ -0,0 +1,52 @@
|
|
|
1
|
+
# Technical Preferences (Organization Profile)
|
|
2
|
+
|
|
3
|
+
Purpose: a single source of truth for default technology choices, standards, and guardrails. Agents use this to bias recommendations and templates. Teams may override with project-specific addenda.
|
|
4
|
+
|
|
5
|
+
Update policy: treat this like a living ADR. Keep concise and actionable.
|
|
6
|
+
|
|
7
|
+
## Frontend
|
|
8
|
+
- Primary frameworks: [...]
|
|
9
|
+
- Language/TS policy: [...]
|
|
10
|
+
- Testing: Unit (e.g., Vitest/Jest), Component (e.g., Testing Library), E2E (e.g., Playwright)
|
|
11
|
+
- Documentation: Storybook/MDX preferred; architecture decisions recorded under docs/architecture.
|
|
12
|
+
- Accessibility: WCAG 2.2 AA baseline; axe checks in CI.
|
|
13
|
+
|
|
14
|
+
## Backend
|
|
15
|
+
- Languages/runtimes: [...]
|
|
16
|
+
- Frameworks: [...]
|
|
17
|
+
- Service style: Prefer modular monolith → move to microservices when justified by scale/team topology.
|
|
18
|
+
- API: REST first; GraphQL by exception (document rationale); gRPC for internal high-throughput services.
|
|
19
|
+
- AuthN/Z: Centralized via SSO/IAM; zero trust principles.
|
|
20
|
+
|
|
21
|
+
## Data
|
|
22
|
+
- Primary databases: [...]
|
|
23
|
+
- Caching/message bus: [...]
|
|
24
|
+
- Object storage: [...]
|
|
25
|
+
- Migration/versioning: [...]
|
|
26
|
+
- Backup/restore objectives: RPO/RTO targets [...]
|
|
27
|
+
|
|
28
|
+
## CI/CD
|
|
29
|
+
- CI: [...]
|
|
30
|
+
- Strategy: trunk-based with feature flags; short-lived branches; protected main.
|
|
31
|
+
- Quality gates: lint, unit, integration, security scan before merge; release validation suite before deploy.
|
|
32
|
+
|
|
33
|
+
## Cloud & Infra
|
|
34
|
+
- Target environments: [...]
|
|
35
|
+
- IaC: [...]; environments as code; immutable artifacts.
|
|
36
|
+
- Secrets: central secret manager; never in repo; rotate quarterly.
|
|
37
|
+
|
|
38
|
+
## Observability
|
|
39
|
+
- Logging/metrics/tracing stack: [...]
|
|
40
|
+
- SLOs/SLIs: define for top user journeys; alert on burn rate.
|
|
41
|
+
|
|
42
|
+
## Security
|
|
43
|
+
- Baseline: OWASP ASVS Level 2; OWASP Top 10 policy in CI.
|
|
44
|
+
- SSO/IAM: [...]; least privilege; periodic access reviews.
|
|
45
|
+
|
|
46
|
+
## Anti-patterns to avoid
|
|
47
|
+
- Accidental polyglot without ownership; bespoke frameworks; duplicated CI pipelines per repo.
|
|
48
|
+
|
|
49
|
+
## How agents use this file
|
|
50
|
+
- Architect: bias solution options and ADRs; reference in architecture-tmpl sections.
|
|
51
|
+
- Dev/QA: reference for test tooling and gates.
|
|
52
|
+
- PO/PM: use to set non-functional acceptance criteria.
|
|
@@ -0,0 +1,43 @@
|
|
|
1
|
+
# Test Levels Framework (Company)
|
|
2
|
+
|
|
3
|
+
Establish a shared mental model for test scope and the entry/exit criteria per level.
|
|
4
|
+
|
|
5
|
+
## Levels
|
|
6
|
+
- Unit: fast (<100ms), isolated, logic correctness, mock I/O.
|
|
7
|
+
- Component: UI or service component in isolation with fakes.
|
|
8
|
+
- Integration: contracts across modules/services and persistence.
|
|
9
|
+
- E2E: critical user journeys across the stack.
|
|
10
|
+
- Non-functional: performance, security, reliability, accessibility.
|
|
11
|
+
- Release validation: smoke checks and rollback readiness post-deploy.
|
|
12
|
+
|
|
13
|
+
## Selection criteria
|
|
14
|
+
- Risk: High-risk changes demand broader coverage (integration/E2E).
|
|
15
|
+
- Visibility: User-facing/critical flows need E2E checks.
|
|
16
|
+
- Coupling: Tightly coupled modules benefit from integration tests.
|
|
17
|
+
- Cost: Prefer unit/component until risk justifies higher levels.
|
|
18
|
+
|
|
19
|
+
## Entry/Exit (per level)
|
|
20
|
+
- Unit
|
|
21
|
+
- Entry: functions/classes with defined behavior.
|
|
22
|
+
- Exit: branches and edge cases covered; no external I/O.
|
|
23
|
+
- Integration
|
|
24
|
+
- Entry: APIs/contracts between modules or DB access present.
|
|
25
|
+
- Exit: happy path + 2 failure modes; DB migrations verified.
|
|
26
|
+
- E2E
|
|
27
|
+
- Entry: stable UI/API endpoints and data; flake budget defined.
|
|
28
|
+
- Exit: top journeys pass; screenshots/traces captured.
|
|
29
|
+
- Non-functional
|
|
30
|
+
- Entry: target SLO/SLI, workload profile, and environment ready.
|
|
31
|
+
- Exit: results documented vs baseline; actions filed for regressions.
|
|
32
|
+
- Release validation
|
|
33
|
+
- Entry: artifact deployed to staging/prod; feature flags configured.
|
|
34
|
+
- Exit: smoke suite pass; rollback plan verified.
|
|
35
|
+
|
|
36
|
+
## Example mapping
|
|
37
|
+
- Change: pricing algorithm logic → Unit + Integration (pricing service ↔ DB).
|
|
38
|
+
- Change: login UI → Component + E2E (happy path + lockout edge case).
|
|
39
|
+
- Change: DB migration → Integration + Release validation.
|
|
40
|
+
|
|
41
|
+
## References in this repository
|
|
42
|
+
- Use with QA tasks: test-design, gate, verify-jira-story-e2e.
|
|
43
|
+
- Use with Dev tasks: run-tests, implement-unit-tests.
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
# Test Priorities Matrix (Company)
|
|
2
|
+
|
|
3
|
+
Prioritize what to test first by Risk = Probability × Impact. Default heuristics below; calibrate per project.
|
|
4
|
+
|
|
5
|
+
## Priority bands
|
|
6
|
+
- P0 (Blocker): Critical path breakage, security exposure, data loss, compliance.
|
|
7
|
+
- P1 (High): High-usage features, SLA/SLO-affecting issues, money flows.
|
|
8
|
+
- P2 (Medium): Secondary flows, uncommon states, degraded UX.
|
|
9
|
+
- P3 (Low): Cosmetic issues, low-usage admin screens.
|
|
10
|
+
|
|
11
|
+
## Quick scoring
|
|
12
|
+
- Probability: 1 (unlikely) – 5 (very likely) considering change area, churn, complexity.
|
|
13
|
+
- Impact: 1 (minimal) – 5 (severe) considering user, financial, compliance, ops.
|
|
14
|
+
- Risk score = P × I. Map 20–25 → P0, 12–19 → P1, 6–11 → P2, 1–5 → P3.
|
|
15
|
+
|
|
16
|
+
## How to apply in a story
|
|
17
|
+
1. List scenarios (happy path, alt paths, error states).
|
|
18
|
+
2. Score each scenario; pick top-3 by risk for immediate coverage.
|
|
19
|
+
3. Map P0/P1 to E2E or integration; P2 to component/unit; P3 opportunistic.
|
|
20
|
+
4. Record rationale in story test notes; align with test-levels-framework.
|
|
21
|
+
|
|
22
|
+
## Anti-patterns
|
|
23
|
+
- Equal priority for all tests; E2E-only mindset; skipping risk rationale.
|
|
24
|
+
|
|
25
|
+
## References in this repository
|
|
26
|
+
- Use with QA tasks: test-design, gate; Dev: run-tests, implement-unit-tests.
|