@posx/core 5.5.166 → 5.5.168
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/build/index.d.ts +6 -3
- package/build/index.js +1 -1
- package/package.json +1 -1
- package/package.publish.json +1 -1
- package/.bmad-core/agent-teams/team-all.yaml +0 -14
- package/.bmad-core/agent-teams/team-fullstack.yaml +0 -18
- package/.bmad-core/agent-teams/team-ide-minimal.yaml +0 -10
- package/.bmad-core/agent-teams/team-no-ui.yaml +0 -13
- package/.bmad-core/agents/analyst.md +0 -81
- package/.bmad-core/agents/architect.md +0 -83
- package/.bmad-core/agents/bmad-master.md +0 -107
- package/.bmad-core/agents/bmad-orchestrator.md +0 -149
- package/.bmad-core/agents/dev.md +0 -75
- package/.bmad-core/agents/pm.md +0 -81
- package/.bmad-core/agents/po.md +0 -76
- package/.bmad-core/agents/qa.md +0 -69
- package/.bmad-core/agents/sm.md +0 -62
- package/.bmad-core/agents/ux-expert.md +0 -66
- package/.bmad-core/bmad-core/user-guide.md +0 -0
- package/.bmad-core/checklists/architect-checklist.md +0 -443
- package/.bmad-core/checklists/change-checklist.md +0 -182
- package/.bmad-core/checklists/pm-checklist.md +0 -375
- package/.bmad-core/checklists/po-master-checklist.md +0 -441
- package/.bmad-core/checklists/story-dod-checklist.md +0 -101
- package/.bmad-core/checklists/story-draft-checklist.md +0 -156
- package/.bmad-core/core-config.yaml +0 -20
- package/.bmad-core/data/bmad-kb.md +0 -813
- package/.bmad-core/data/brainstorming-techniques.md +0 -36
- package/.bmad-core/data/elicitation-methods.md +0 -154
- package/.bmad-core/data/technical-preferences.md +0 -3
- package/.bmad-core/enhanced-ide-development-workflow.md +0 -43
- package/.bmad-core/install-manifest.yaml +0 -207
- package/.bmad-core/tasks/advanced-elicitation.md +0 -119
- package/.bmad-core/tasks/brownfield-create-epic.md +0 -160
- package/.bmad-core/tasks/brownfield-create-story.md +0 -147
- package/.bmad-core/tasks/correct-course.md +0 -70
- package/.bmad-core/tasks/create-brownfield-story.md +0 -321
- package/.bmad-core/tasks/create-deep-research-prompt.md +0 -289
- package/.bmad-core/tasks/create-doc.md +0 -101
- package/.bmad-core/tasks/create-next-story.md +0 -112
- package/.bmad-core/tasks/document-project.md +0 -347
- package/.bmad-core/tasks/execute-checklist.md +0 -93
- package/.bmad-core/tasks/facilitate-brainstorming-session.md +0 -136
- package/.bmad-core/tasks/generate-ai-frontend-prompt.md +0 -51
- package/.bmad-core/tasks/index-docs.md +0 -178
- package/.bmad-core/tasks/kb-mode-interaction.md +0 -75
- package/.bmad-core/tasks/review-story.md +0 -162
- package/.bmad-core/tasks/shard-doc.md +0 -187
- package/.bmad-core/tasks/validate-next-story.md +0 -134
- package/.bmad-core/templates/architecture-tmpl.yaml +0 -650
- package/.bmad-core/templates/brainstorming-output-tmpl.yaml +0 -156
- package/.bmad-core/templates/brownfield-architecture-tmpl.yaml +0 -476
- package/.bmad-core/templates/brownfield-prd-tmpl.yaml +0 -280
- package/.bmad-core/templates/competitor-analysis-tmpl.yaml +0 -293
- package/.bmad-core/templates/front-end-architecture-tmpl.yaml +0 -206
- package/.bmad-core/templates/front-end-spec-tmpl.yaml +0 -349
- package/.bmad-core/templates/fullstack-architecture-tmpl.yaml +0 -805
- package/.bmad-core/templates/market-research-tmpl.yaml +0 -252
- package/.bmad-core/templates/prd-tmpl.yaml +0 -202
- package/.bmad-core/templates/project-brief-tmpl.yaml +0 -221
- package/.bmad-core/templates/story-tmpl.yaml +0 -137
- package/.bmad-core/user-guide.md +0 -251
- package/.bmad-core/utils/bmad-doc-template.md +0 -325
- package/.bmad-core/utils/workflow-management.md +0 -69
- package/.bmad-core/workflows/brownfield-fullstack.yaml +0 -297
- package/.bmad-core/workflows/brownfield-service.yaml +0 -187
- package/.bmad-core/workflows/brownfield-ui.yaml +0 -197
- package/.bmad-core/workflows/greenfield-fullstack.yaml +0 -240
- package/.bmad-core/workflows/greenfield-service.yaml +0 -206
- package/.bmad-core/workflows/greenfield-ui.yaml +0 -235
- package/.bmad-core/working-in-the-brownfield.md +0 -364
- package/.claude/commands/BMad/agents/analyst.md +0 -85
- package/.claude/commands/BMad/agents/architect.md +0 -87
- package/.claude/commands/BMad/agents/bmad-master.md +0 -111
- package/.claude/commands/BMad/agents/bmad-orchestrator.md +0 -153
- package/.claude/commands/BMad/agents/dev.md +0 -79
- package/.claude/commands/BMad/agents/pm.md +0 -85
- package/.claude/commands/BMad/agents/po.md +0 -80
- package/.claude/commands/BMad/agents/qa.md +0 -73
- package/.claude/commands/BMad/agents/sm.md +0 -66
- package/.claude/commands/BMad/agents/ux-expert.md +0 -70
- package/.claude/commands/BMad/tasks/advanced-elicitation.md +0 -123
- package/.claude/commands/BMad/tasks/brownfield-create-epic.md +0 -164
- package/.claude/commands/BMad/tasks/brownfield-create-story.md +0 -151
- package/.claude/commands/BMad/tasks/correct-course.md +0 -74
- package/.claude/commands/BMad/tasks/create-brownfield-story.md +0 -325
- package/.claude/commands/BMad/tasks/create-deep-research-prompt.md +0 -293
- package/.claude/commands/BMad/tasks/create-doc.md +0 -105
- package/.claude/commands/BMad/tasks/create-next-story.md +0 -116
- package/.claude/commands/BMad/tasks/document-project.md +0 -351
- package/.claude/commands/BMad/tasks/execute-checklist.md +0 -97
- package/.claude/commands/BMad/tasks/facilitate-brainstorming-session.md +0 -140
- package/.claude/commands/BMad/tasks/generate-ai-frontend-prompt.md +0 -55
- package/.claude/commands/BMad/tasks/index-docs.md +0 -182
- package/.claude/commands/BMad/tasks/kb-mode-interaction.md +0 -79
- package/.claude/commands/BMad/tasks/review-story.md +0 -166
- package/.claude/commands/BMad/tasks/shard-doc.md +0 -191
- package/.claude/commands/BMad/tasks/validate-next-story.md +0 -138
- package/.cursor/rules/analyst.mdc +0 -95
- package/.cursor/rules/architect.mdc +0 -97
- package/.cursor/rules/bmad-master.mdc +0 -121
- package/.cursor/rules/bmad-orchestrator.mdc +0 -163
- package/.cursor/rules/dev.mdc +0 -89
- package/.cursor/rules/pm.mdc +0 -95
- package/.cursor/rules/po.mdc +0 -90
- package/.cursor/rules/qa.mdc +0 -83
- package/.cursor/rules/sm.mdc +0 -76
- package/.cursor/rules/ux-expert.mdc +0 -80
|
@@ -1,116 +0,0 @@
|
|
|
1
|
-
# /create-next-story Task
|
|
2
|
-
|
|
3
|
-
When this command is used, execute the following task:
|
|
4
|
-
|
|
5
|
-
# Create Next Story Task
|
|
6
|
-
|
|
7
|
-
## Purpose
|
|
8
|
-
|
|
9
|
-
To identify the next logical story based on project progress and epic definitions, and then to prepare a comprehensive, self-contained, and actionable story file using the `Story Template`. This task ensures the story is enriched with all necessary technical context, requirements, and acceptance criteria, making it ready for efficient implementation by a Developer Agent with minimal need for additional research or finding its own context.
|
|
10
|
-
|
|
11
|
-
## SEQUENTIAL Task Execution (Do not proceed until current Task is complete)
|
|
12
|
-
|
|
13
|
-
### 0. Load Core Configuration and Check Workflow
|
|
14
|
-
|
|
15
|
-
- Load `.bmad-core/core-config.yaml` from the project root
|
|
16
|
-
- If the file does not exist, HALT and inform the user: "core-config.yaml not found. This file is required for story creation. You can either: 1) Copy it from GITHUB bmad-core/core-config.yaml and configure it for your project OR 2) Run the BMad installer against your project to upgrade and add the file automatically. Please add and configure core-config.yaml before proceeding."
|
|
17
|
-
- Extract key configurations: `devStoryLocation`, `prd.*`, `architecture.*`, `workflow.*`
|
|
18
|
-
|
|
19
|
-
### 1. Identify Next Story for Preparation
|
|
20
|
-
|
|
21
|
-
#### 1.1 Locate Epic Files and Review Existing Stories
|
|
22
|
-
|
|
23
|
-
- Based on `prdSharded` from config, locate epic files (sharded location/pattern or monolithic PRD sections)
|
|
24
|
-
- If `devStoryLocation` has story files, load the highest `{epicNum}.{storyNum}.story.md` file
|
|
25
|
-
- **If highest story exists:**
|
|
26
|
-
- Verify status is 'Done'. If not, alert user: "ALERT: Found incomplete story! File: {lastEpicNum}.{lastStoryNum}.story.md Status: [current status] You should fix this story first, but would you like to accept risk & override to create the next story in draft?"
|
|
27
|
-
- If proceeding, select next sequential story in the current epic
|
|
28
|
-
- If epic is complete, prompt user: "Epic {epicNum} Complete: All stories in Epic {epicNum} have been completed. Would you like to: 1) Begin Epic {epicNum + 1} with story 1 2) Select a specific story to work on 3) Cancel story creation"
|
|
29
|
-
- **CRITICAL**: NEVER automatically skip to another epic. User MUST explicitly instruct which story to create.
|
|
30
|
-
- **If no story files exist:** The next story is ALWAYS 1.1 (first story of first epic)
|
|
31
|
-
- Announce the identified story to the user: "Identified next story for preparation: {epicNum}.{storyNum} - {Story Title}"
|
|
32
|
-
|
|
33
|
-
### 2. Gather Story Requirements and Previous Story Context
|
|
34
|
-
|
|
35
|
-
- Extract story requirements from the identified epic file
|
|
36
|
-
- If previous story exists, review Dev Agent Record sections for:
|
|
37
|
-
- Completion Notes and Debug Log References
|
|
38
|
-
- Implementation deviations and technical decisions
|
|
39
|
-
- Challenges encountered and lessons learned
|
|
40
|
-
- Extract relevant insights that inform the current story's preparation
|
|
41
|
-
|
|
42
|
-
### 3. Gather Architecture Context
|
|
43
|
-
|
|
44
|
-
#### 3.1 Determine Architecture Reading Strategy
|
|
45
|
-
|
|
46
|
-
- **If `architectureVersion: >= v4` and `architectureSharded: true`**: Read `{architectureShardedLocation}/index.md` then follow structured reading order below
|
|
47
|
-
- **Else**: Use monolithic `architectureFile` for similar sections
|
|
48
|
-
|
|
49
|
-
#### 3.2 Read Architecture Documents Based on Story Type
|
|
50
|
-
|
|
51
|
-
**For ALL Stories:** tech-stack.md, unified-project-structure.md, coding-standards.md, testing-strategy.md
|
|
52
|
-
|
|
53
|
-
**For Backend/API Stories, additionally:** data-models.md, database-schema.md, backend-architecture.md, rest-api-spec.md, external-apis.md
|
|
54
|
-
|
|
55
|
-
**For Frontend/UI Stories, additionally:** frontend-architecture.md, components.md, core-workflows.md, data-models.md
|
|
56
|
-
|
|
57
|
-
**For Full-Stack Stories:** Read both Backend and Frontend sections above
|
|
58
|
-
|
|
59
|
-
#### 3.3 Extract Story-Specific Technical Details
|
|
60
|
-
|
|
61
|
-
Extract ONLY information directly relevant to implementing the current story. Do NOT invent new libraries, patterns, or standards not in the source documents.
|
|
62
|
-
|
|
63
|
-
Extract:
|
|
64
|
-
|
|
65
|
-
- Specific data models, schemas, or structures the story will use
|
|
66
|
-
- API endpoints the story must implement or consume
|
|
67
|
-
- Component specifications for UI elements in the story
|
|
68
|
-
- File paths and naming conventions for new code
|
|
69
|
-
- Testing requirements specific to the story's features
|
|
70
|
-
- Security or performance considerations affecting the story
|
|
71
|
-
|
|
72
|
-
ALWAYS cite source documents: `[Source: architecture/{filename}.md#{section}]`
|
|
73
|
-
|
|
74
|
-
### 4. Verify Project Structure Alignment
|
|
75
|
-
|
|
76
|
-
- Cross-reference story requirements with Project Structure Guide from `docs/architecture/unified-project-structure.md`
|
|
77
|
-
- Ensure file paths, component locations, or module names align with defined structures
|
|
78
|
-
- Document any structural conflicts in "Project Structure Notes" section within the story draft
|
|
79
|
-
|
|
80
|
-
### 5. Populate Story Template with Full Context
|
|
81
|
-
|
|
82
|
-
- Create new story file: `{devStoryLocation}/{epicNum}.{storyNum}.story.md` using Story Template
|
|
83
|
-
- Fill in basic story information: Title, Status (Draft), Story statement, Acceptance Criteria from Epic
|
|
84
|
-
- **`Dev Notes` section (CRITICAL):**
|
|
85
|
-
- CRITICAL: This section MUST contain ONLY information extracted from architecture documents. NEVER invent or assume technical details.
|
|
86
|
-
- Include ALL relevant technical details from Steps 2-3, organized by category:
|
|
87
|
-
- **Previous Story Insights**: Key learnings from previous story
|
|
88
|
-
- **Data Models**: Specific schemas, validation rules, relationships [with source references]
|
|
89
|
-
- **API Specifications**: Endpoint details, request/response formats, auth requirements [with source references]
|
|
90
|
-
- **Component Specifications**: UI component details, props, state management [with source references]
|
|
91
|
-
- **File Locations**: Exact paths where new code should be created based on project structure
|
|
92
|
-
- **Testing Requirements**: Specific test cases or strategies from testing-strategy.md
|
|
93
|
-
- **Technical Constraints**: Version requirements, performance considerations, security rules
|
|
94
|
-
- Every technical detail MUST include its source reference: `[Source: architecture/{filename}.md#{section}]`
|
|
95
|
-
- If information for a category is not found in the architecture docs, explicitly state: "No specific guidance found in architecture docs"
|
|
96
|
-
- **`Tasks / Subtasks` section:**
|
|
97
|
-
- Generate detailed, sequential list of technical tasks based ONLY on: Epic Requirements, Story AC, Reviewed Architecture Information
|
|
98
|
-
- Each task must reference relevant architecture documentation
|
|
99
|
-
- Include unit testing as explicit subtasks based on the Testing Strategy
|
|
100
|
-
- Link tasks to ACs where applicable (e.g., `Task 1 (AC: 1, 3)`)
|
|
101
|
-
- Add notes on project structure alignment or discrepancies found in Step 4
|
|
102
|
-
|
|
103
|
-
### 6. Story Draft Completion and Review
|
|
104
|
-
|
|
105
|
-
- Review all sections for completeness and accuracy
|
|
106
|
-
- Verify all source references are included for technical details
|
|
107
|
-
- Ensure tasks align with both epic requirements and architecture constraints
|
|
108
|
-
- Update status to "Draft" and save the story file
|
|
109
|
-
- Execute `.bmad-core/tasks/execute-checklist` `.bmad-core/checklists/story-draft-checklist`
|
|
110
|
-
- Provide summary to user including:
|
|
111
|
-
- Story created: `{devStoryLocation}/{epicNum}.{storyNum}.story.md`
|
|
112
|
-
- Status: Draft
|
|
113
|
-
- Key technical components included from architecture docs
|
|
114
|
-
- Any deviations or conflicts noted between epic and architecture
|
|
115
|
-
- Checklist Results
|
|
116
|
-
- Next steps: For Complex stories, suggest the user carefully review the story draft and also optionally have the PO run the task `.bmad-core/tasks/validate-next-story`
|
|
@@ -1,351 +0,0 @@
|
|
|
1
|
-
# /document-project Task
|
|
2
|
-
|
|
3
|
-
When this command is used, execute the following task:
|
|
4
|
-
|
|
5
|
-
# Document an Existing Project
|
|
6
|
-
|
|
7
|
-
## Purpose
|
|
8
|
-
|
|
9
|
-
Generate comprehensive documentation for existing projects optimized for AI development agents. This task creates structured reference materials that enable AI agents to understand project context, conventions, and patterns for effective contribution to any codebase.
|
|
10
|
-
|
|
11
|
-
## Task Instructions
|
|
12
|
-
|
|
13
|
-
### 1. Initial Project Analysis
|
|
14
|
-
|
|
15
|
-
**CRITICAL:** First, check if a PRD or requirements document exists in context. If yes, use it to focus your documentation efforts on relevant areas only.
|
|
16
|
-
|
|
17
|
-
**IF PRD EXISTS**:
|
|
18
|
-
|
|
19
|
-
- Review the PRD to understand what enhancement/feature is planned
|
|
20
|
-
- Identify which modules, services, or areas will be affected
|
|
21
|
-
- Focus documentation ONLY on these relevant areas
|
|
22
|
-
- Skip unrelated parts of the codebase to keep docs lean
|
|
23
|
-
|
|
24
|
-
**IF NO PRD EXISTS**:
|
|
25
|
-
Ask the user:
|
|
26
|
-
|
|
27
|
-
"I notice you haven't provided a PRD or requirements document. To create more focused and useful documentation, I recommend one of these options:
|
|
28
|
-
|
|
29
|
-
1. **Create a PRD first** - Would you like me to help create a brownfield PRD before documenting? This helps focus documentation on relevant areas.
|
|
30
|
-
|
|
31
|
-
2. **Provide existing requirements** - Do you have a requirements document, epic, or feature description you can share?
|
|
32
|
-
|
|
33
|
-
3. **Describe the focus** - Can you briefly describe what enhancement or feature you're planning? For example:
|
|
34
|
-
|
|
35
|
-
- 'Adding payment processing to the user service'
|
|
36
|
-
- 'Refactoring the authentication module'
|
|
37
|
-
- 'Integrating with a new third-party API'
|
|
38
|
-
|
|
39
|
-
4. **Document everything** - Or should I proceed with comprehensive documentation of the entire codebase? (Note: This may create excessive documentation for large projects)
|
|
40
|
-
|
|
41
|
-
Please let me know your preference, or I can proceed with full documentation if you prefer."
|
|
42
|
-
|
|
43
|
-
Based on their response:
|
|
44
|
-
|
|
45
|
-
- If they choose option 1-3: Use that context to focus documentation
|
|
46
|
-
- If they choose option 4 or decline: Proceed with comprehensive analysis below
|
|
47
|
-
|
|
48
|
-
Begin by conducting analysis of the existing project. Use available tools to:
|
|
49
|
-
|
|
50
|
-
1. **Project Structure Discovery**: Examine the root directory structure, identify main folders, and understand the overall organization
|
|
51
|
-
2. **Technology Stack Identification**: Look for package.json, requirements.txt, Cargo.toml, pom.xml, etc. to identify languages, frameworks, and dependencies
|
|
52
|
-
3. **Build System Analysis**: Find build scripts, CI/CD configurations, and development commands
|
|
53
|
-
4. **Existing Documentation Review**: Check for README files, docs folders, and any existing documentation
|
|
54
|
-
5. **Code Pattern Analysis**: Sample key files to understand coding patterns, naming conventions, and architectural approaches
|
|
55
|
-
|
|
56
|
-
Ask the user these elicitation questions to better understand their needs:
|
|
57
|
-
|
|
58
|
-
- What is the primary purpose of this project?
|
|
59
|
-
- Are there any specific areas of the codebase that are particularly complex or important for agents to understand?
|
|
60
|
-
- What types of tasks do you expect AI agents to perform on this project? (e.g., bug fixes, feature additions, refactoring, testing)
|
|
61
|
-
- Are there any existing documentation standards or formats you prefer?
|
|
62
|
-
- What level of technical detail should the documentation target? (junior developers, senior developers, mixed team)
|
|
63
|
-
- Is there a specific feature or enhancement you're planning? (This helps focus documentation)
|
|
64
|
-
|
|
65
|
-
### 2. Deep Codebase Analysis
|
|
66
|
-
|
|
67
|
-
CRITICAL: Before generating documentation, conduct extensive analysis of the existing codebase:
|
|
68
|
-
|
|
69
|
-
1. **Explore Key Areas**:
|
|
70
|
-
|
|
71
|
-
- Entry points (main files, index files, app initializers)
|
|
72
|
-
- Configuration files and environment setup
|
|
73
|
-
- Package dependencies and versions
|
|
74
|
-
- Build and deployment configurations
|
|
75
|
-
- Test suites and coverage
|
|
76
|
-
|
|
77
|
-
2. **Ask Clarifying Questions**:
|
|
78
|
-
|
|
79
|
-
- "I see you're using [technology X]. Are there any custom patterns or conventions I should document?"
|
|
80
|
-
- "What are the most critical/complex parts of this system that developers struggle with?"
|
|
81
|
-
- "Are there any undocumented 'tribal knowledge' areas I should capture?"
|
|
82
|
-
- "What technical debt or known issues should I document?"
|
|
83
|
-
- "Which parts of the codebase change most frequently?"
|
|
84
|
-
|
|
85
|
-
3. **Map the Reality**:
|
|
86
|
-
- Identify ACTUAL patterns used (not theoretical best practices)
|
|
87
|
-
- Find where key business logic lives
|
|
88
|
-
- Locate integration points and external dependencies
|
|
89
|
-
- Document workarounds and technical debt
|
|
90
|
-
- Note areas that differ from standard patterns
|
|
91
|
-
|
|
92
|
-
**IF PRD PROVIDED**: Also analyze what would need to change for the enhancement
|
|
93
|
-
|
|
94
|
-
### 3. Core Documentation Generation
|
|
95
|
-
|
|
96
|
-
[[LLM: Generate a comprehensive BROWNFIELD architecture document that reflects the ACTUAL state of the codebase.
|
|
97
|
-
|
|
98
|
-
**CRITICAL**: This is NOT an aspirational architecture document. Document what EXISTS, including:
|
|
99
|
-
|
|
100
|
-
- Technical debt and workarounds
|
|
101
|
-
- Inconsistent patterns between different parts
|
|
102
|
-
- Legacy code that can't be changed
|
|
103
|
-
- Integration constraints
|
|
104
|
-
- Performance bottlenecks
|
|
105
|
-
|
|
106
|
-
**Document Structure**:
|
|
107
|
-
|
|
108
|
-
# [Project Name] Brownfield Architecture Document
|
|
109
|
-
|
|
110
|
-
## Introduction
|
|
111
|
-
|
|
112
|
-
This document captures the CURRENT STATE of the [Project Name] codebase, including technical debt, workarounds, and real-world patterns. It serves as a reference for AI agents working on enhancements.
|
|
113
|
-
|
|
114
|
-
### Document Scope
|
|
115
|
-
|
|
116
|
-
[If PRD provided: "Focused on areas relevant to: {enhancement description}"]
|
|
117
|
-
[If no PRD: "Comprehensive documentation of entire system"]
|
|
118
|
-
|
|
119
|
-
### Change Log
|
|
120
|
-
|
|
121
|
-
| Date | Version | Description | Author |
|
|
122
|
-
| ------ | ------- | --------------------------- | --------- |
|
|
123
|
-
| [Date] | 1.0 | Initial brownfield analysis | [Analyst] |
|
|
124
|
-
|
|
125
|
-
## Quick Reference - Key Files and Entry Points
|
|
126
|
-
|
|
127
|
-
### Critical Files for Understanding the System
|
|
128
|
-
|
|
129
|
-
- **Main Entry**: `src/index.js` (or actual entry point)
|
|
130
|
-
- **Configuration**: `config/app.config.js`, `.env.example`
|
|
131
|
-
- **Core Business Logic**: `src/services/`, `src/domain/`
|
|
132
|
-
- **API Definitions**: `src/routes/` or link to OpenAPI spec
|
|
133
|
-
- **Database Models**: `src/models/` or link to schema files
|
|
134
|
-
- **Key Algorithms**: [List specific files with complex logic]
|
|
135
|
-
|
|
136
|
-
### If PRD Provided - Enhancement Impact Areas
|
|
137
|
-
|
|
138
|
-
[Highlight which files/modules will be affected by the planned enhancement]
|
|
139
|
-
|
|
140
|
-
## High Level Architecture
|
|
141
|
-
|
|
142
|
-
### Technical Summary
|
|
143
|
-
|
|
144
|
-
### Actual Tech Stack (from package.json/requirements.txt)
|
|
145
|
-
|
|
146
|
-
| Category | Technology | Version | Notes |
|
|
147
|
-
| --------- | ---------- | ------- | -------------------------- |
|
|
148
|
-
| Runtime | Node.js | 16.x | [Any constraints] |
|
|
149
|
-
| Framework | Express | 4.18.2 | [Custom middleware?] |
|
|
150
|
-
| Database | PostgreSQL | 13 | [Connection pooling setup] |
|
|
151
|
-
|
|
152
|
-
etc...
|
|
153
|
-
|
|
154
|
-
### Repository Structure Reality Check
|
|
155
|
-
|
|
156
|
-
- Type: [Monorepo/Polyrepo/Hybrid]
|
|
157
|
-
- Package Manager: [npm/yarn/pnpm]
|
|
158
|
-
- Notable: [Any unusual structure decisions]
|
|
159
|
-
|
|
160
|
-
## Source Tree and Module Organization
|
|
161
|
-
|
|
162
|
-
### Project Structure (Actual)
|
|
163
|
-
|
|
164
|
-
```text
|
|
165
|
-
project-root/
|
|
166
|
-
├── src/
|
|
167
|
-
│ ├── controllers/ # HTTP request handlers
|
|
168
|
-
│ ├── services/ # Business logic (NOTE: inconsistent patterns between user and payment services)
|
|
169
|
-
│ ├── models/ # Database models (Sequelize)
|
|
170
|
-
│ ├── utils/ # Mixed bag - needs refactoring
|
|
171
|
-
│ └── legacy/ # DO NOT MODIFY - old payment system still in use
|
|
172
|
-
├── tests/ # Jest tests (60% coverage)
|
|
173
|
-
├── scripts/ # Build and deployment scripts
|
|
174
|
-
└── config/ # Environment configs
|
|
175
|
-
```
|
|
176
|
-
|
|
177
|
-
### Key Modules and Their Purpose
|
|
178
|
-
|
|
179
|
-
- **User Management**: `src/services/userService.js` - Handles all user operations
|
|
180
|
-
- **Authentication**: `src/middleware/auth.js` - JWT-based, custom implementation
|
|
181
|
-
- **Payment Processing**: `src/legacy/payment.js` - CRITICAL: Do not refactor, tightly coupled
|
|
182
|
-
- **[List other key modules with their actual files]**
|
|
183
|
-
|
|
184
|
-
## Data Models and APIs
|
|
185
|
-
|
|
186
|
-
### Data Models
|
|
187
|
-
|
|
188
|
-
Instead of duplicating, reference actual model files:
|
|
189
|
-
|
|
190
|
-
- **User Model**: See `src/models/User.js`
|
|
191
|
-
- **Order Model**: See `src/models/Order.js`
|
|
192
|
-
- **Related Types**: TypeScript definitions in `src/types/`
|
|
193
|
-
|
|
194
|
-
### API Specifications
|
|
195
|
-
|
|
196
|
-
- **OpenAPI Spec**: `docs/api/openapi.yaml` (if exists)
|
|
197
|
-
- **Postman Collection**: `docs/api/postman-collection.json`
|
|
198
|
-
- **Manual Endpoints**: [List any undocumented endpoints discovered]
|
|
199
|
-
|
|
200
|
-
## Technical Debt and Known Issues
|
|
201
|
-
|
|
202
|
-
### Critical Technical Debt
|
|
203
|
-
|
|
204
|
-
1. **Payment Service**: Legacy code in `src/legacy/payment.js` - tightly coupled, no tests
|
|
205
|
-
2. **User Service**: Different pattern than other services, uses callbacks instead of promises
|
|
206
|
-
3. **Database Migrations**: Manually tracked, no proper migration tool
|
|
207
|
-
4. **[Other significant debt]**
|
|
208
|
-
|
|
209
|
-
### Workarounds and Gotchas
|
|
210
|
-
|
|
211
|
-
- **Environment Variables**: Must set `NODE_ENV=production` even for staging (historical reason)
|
|
212
|
-
- **Database Connections**: Connection pool hardcoded to 10, changing breaks payment service
|
|
213
|
-
- **[Other workarounds developers need to know]**
|
|
214
|
-
|
|
215
|
-
## Integration Points and External Dependencies
|
|
216
|
-
|
|
217
|
-
### External Services
|
|
218
|
-
|
|
219
|
-
| Service | Purpose | Integration Type | Key Files |
|
|
220
|
-
| -------- | -------- | ---------------- | ------------------------------ |
|
|
221
|
-
| Stripe | Payments | REST API | `src/integrations/stripe/` |
|
|
222
|
-
| SendGrid | Emails | SDK | `src/services/emailService.js` |
|
|
223
|
-
|
|
224
|
-
etc...
|
|
225
|
-
|
|
226
|
-
### Internal Integration Points
|
|
227
|
-
|
|
228
|
-
- **Frontend Communication**: REST API on port 3000, expects specific headers
|
|
229
|
-
- **Background Jobs**: Redis queue, see `src/workers/`
|
|
230
|
-
- **[Other integrations]**
|
|
231
|
-
|
|
232
|
-
## Development and Deployment
|
|
233
|
-
|
|
234
|
-
### Local Development Setup
|
|
235
|
-
|
|
236
|
-
1. Actual steps that work (not ideal steps)
|
|
237
|
-
2. Known issues with setup
|
|
238
|
-
3. Required environment variables (see `.env.example`)
|
|
239
|
-
|
|
240
|
-
### Build and Deployment Process
|
|
241
|
-
|
|
242
|
-
- **Build Command**: `npm run build` (webpack config in `webpack.config.js`)
|
|
243
|
-
- **Deployment**: Manual deployment via `scripts/deploy.sh`
|
|
244
|
-
- **Environments**: Dev, Staging, Prod (see `config/environments/`)
|
|
245
|
-
|
|
246
|
-
## Testing Reality
|
|
247
|
-
|
|
248
|
-
### Current Test Coverage
|
|
249
|
-
|
|
250
|
-
- Unit Tests: 60% coverage (Jest)
|
|
251
|
-
- Integration Tests: Minimal, in `tests/integration/`
|
|
252
|
-
- E2E Tests: None
|
|
253
|
-
- Manual Testing: Primary QA method
|
|
254
|
-
|
|
255
|
-
### Running Tests
|
|
256
|
-
|
|
257
|
-
```bash
|
|
258
|
-
npm test # Runs unit tests
|
|
259
|
-
npm run test:integration # Runs integration tests (requires local DB)
|
|
260
|
-
```
|
|
261
|
-
|
|
262
|
-
## If Enhancement PRD Provided - Impact Analysis
|
|
263
|
-
|
|
264
|
-
### Files That Will Need Modification
|
|
265
|
-
|
|
266
|
-
Based on the enhancement requirements, these files will be affected:
|
|
267
|
-
|
|
268
|
-
- `src/services/userService.js` - Add new user fields
|
|
269
|
-
- `src/models/User.js` - Update schema
|
|
270
|
-
- `src/routes/userRoutes.js` - New endpoints
|
|
271
|
-
- [etc...]
|
|
272
|
-
|
|
273
|
-
### New Files/Modules Needed
|
|
274
|
-
|
|
275
|
-
- `src/services/newFeatureService.js` - New business logic
|
|
276
|
-
- `src/models/NewFeature.js` - New data model
|
|
277
|
-
- [etc...]
|
|
278
|
-
|
|
279
|
-
### Integration Considerations
|
|
280
|
-
|
|
281
|
-
- Will need to integrate with existing auth middleware
|
|
282
|
-
- Must follow existing response format in `src/utils/responseFormatter.js`
|
|
283
|
-
- [Other integration points]
|
|
284
|
-
|
|
285
|
-
## Appendix - Useful Commands and Scripts
|
|
286
|
-
|
|
287
|
-
### Frequently Used Commands
|
|
288
|
-
|
|
289
|
-
```bash
|
|
290
|
-
npm run dev # Start development server
|
|
291
|
-
npm run build # Production build
|
|
292
|
-
npm run migrate # Run database migrations
|
|
293
|
-
npm run seed # Seed test data
|
|
294
|
-
```
|
|
295
|
-
|
|
296
|
-
### Debugging and Troubleshooting
|
|
297
|
-
|
|
298
|
-
- **Logs**: Check `logs/app.log` for application logs
|
|
299
|
-
- **Debug Mode**: Set `DEBUG=app:*` for verbose logging
|
|
300
|
-
- **Common Issues**: See `docs/troubleshooting.md`]]
|
|
301
|
-
|
|
302
|
-
### 4. Document Delivery
|
|
303
|
-
|
|
304
|
-
1. **In Web UI (Gemini, ChatGPT, Claude)**:
|
|
305
|
-
|
|
306
|
-
- Present the entire document in one response (or multiple if too long)
|
|
307
|
-
- Tell user to copy and save as `docs/brownfield-architecture.md` or `docs/project-architecture.md`
|
|
308
|
-
- Mention it can be sharded later in IDE if needed
|
|
309
|
-
|
|
310
|
-
2. **In IDE Environment**:
|
|
311
|
-
- Create the document as `docs/brownfield-architecture.md`
|
|
312
|
-
- Inform user this single document contains all architectural information
|
|
313
|
-
- Can be sharded later using PO agent if desired
|
|
314
|
-
|
|
315
|
-
The document should be comprehensive enough that future agents can understand:
|
|
316
|
-
|
|
317
|
-
- The actual state of the system (not idealized)
|
|
318
|
-
- Where to find key files and logic
|
|
319
|
-
- What technical debt exists
|
|
320
|
-
- What constraints must be respected
|
|
321
|
-
- If PRD provided: What needs to change for the enhancement]]
|
|
322
|
-
|
|
323
|
-
### 5. Quality Assurance
|
|
324
|
-
|
|
325
|
-
CRITICAL: Before finalizing the document:
|
|
326
|
-
|
|
327
|
-
1. **Accuracy Check**: Verify all technical details match the actual codebase
|
|
328
|
-
2. **Completeness Review**: Ensure all major system components are documented
|
|
329
|
-
3. **Focus Validation**: If user provided scope, verify relevant areas are emphasized
|
|
330
|
-
4. **Clarity Assessment**: Check that explanations are clear for AI agents
|
|
331
|
-
5. **Navigation**: Ensure document has clear section structure for easy reference
|
|
332
|
-
|
|
333
|
-
Apply the advanced elicitation task after major sections to refine based on user feedback.
|
|
334
|
-
|
|
335
|
-
## Success Criteria
|
|
336
|
-
|
|
337
|
-
- Single comprehensive brownfield architecture document created
|
|
338
|
-
- Document reflects REALITY including technical debt and workarounds
|
|
339
|
-
- Key files and modules are referenced with actual paths
|
|
340
|
-
- Models/APIs reference source files rather than duplicating content
|
|
341
|
-
- If PRD provided: Clear impact analysis showing what needs to change
|
|
342
|
-
- Document enables AI agents to navigate and understand the actual codebase
|
|
343
|
-
- Technical constraints and "gotchas" are clearly documented
|
|
344
|
-
|
|
345
|
-
## Notes
|
|
346
|
-
|
|
347
|
-
- This task creates ONE document that captures the TRUE state of the system
|
|
348
|
-
- References actual files rather than duplicating content when possible
|
|
349
|
-
- Documents technical debt, workarounds, and constraints honestly
|
|
350
|
-
- For brownfield projects with PRD: Provides clear enhancement impact analysis
|
|
351
|
-
- The goal is PRACTICAL documentation for AI agents doing real work
|
|
@@ -1,97 +0,0 @@
|
|
|
1
|
-
# /execute-checklist Task
|
|
2
|
-
|
|
3
|
-
When this command is used, execute the following task:
|
|
4
|
-
|
|
5
|
-
# Checklist Validation Task
|
|
6
|
-
|
|
7
|
-
This task provides instructions for validating documentation against checklists. The agent MUST follow these instructions to ensure thorough and systematic validation of documents.
|
|
8
|
-
|
|
9
|
-
## Available Checklists
|
|
10
|
-
|
|
11
|
-
If the user asks or does not specify a specific checklist, list the checklists available to the agent persona. If the task is being run not with a specific agent, tell the user to check the .bmad-core/checklists folder to select the appropriate one to run.
|
|
12
|
-
|
|
13
|
-
## Instructions
|
|
14
|
-
|
|
15
|
-
1. **Initial Assessment**
|
|
16
|
-
|
|
17
|
-
- If user or the task being run provides a checklist name:
|
|
18
|
-
- Try fuzzy matching (e.g. "architecture checklist" -> "architect-checklist")
|
|
19
|
-
- If multiple matches found, ask user to clarify
|
|
20
|
-
- Load the appropriate checklist from .bmad-core/checklists/
|
|
21
|
-
- If no checklist specified:
|
|
22
|
-
- Ask the user which checklist they want to use
|
|
23
|
-
- Present the available options from the files in the checklists folder
|
|
24
|
-
- Confirm if they want to work through the checklist:
|
|
25
|
-
- Section by section (interactive mode - very time consuming)
|
|
26
|
-
- All at once (YOLO mode - recommended for checklists, there will be a summary of sections at the end to discuss)
|
|
27
|
-
|
|
28
|
-
2. **Document and Artifact Gathering**
|
|
29
|
-
|
|
30
|
-
- Each checklist will specify its required documents/artifacts at the beginning
|
|
31
|
-
- Follow the checklist's specific instructions for what to gather, generally a file can be resolved in the docs folder, if not or unsure, halt and ask or confirm with the user.
|
|
32
|
-
|
|
33
|
-
3. **Checklist Processing**
|
|
34
|
-
|
|
35
|
-
If in interactive mode:
|
|
36
|
-
|
|
37
|
-
- Work through each section of the checklist one at a time
|
|
38
|
-
- For each section:
|
|
39
|
-
- Review all items in the section following instructions for that section embedded in the checklist
|
|
40
|
-
- Check each item against the relevant documentation or artifacts as appropriate
|
|
41
|
-
- Present summary of findings for that section, highlighting warnings, errors and non applicable items (rationale for non-applicability).
|
|
42
|
-
- Get user confirmation before proceeding to next section or if any thing major do we need to halt and take corrective action
|
|
43
|
-
|
|
44
|
-
If in YOLO mode:
|
|
45
|
-
|
|
46
|
-
- Process all sections at once
|
|
47
|
-
- Create a comprehensive report of all findings
|
|
48
|
-
- Present the complete analysis to the user
|
|
49
|
-
|
|
50
|
-
4. **Validation Approach**
|
|
51
|
-
|
|
52
|
-
For each checklist item:
|
|
53
|
-
|
|
54
|
-
- Read and understand the requirement
|
|
55
|
-
- Look for evidence in the documentation that satisfies the requirement
|
|
56
|
-
- Consider both explicit mentions and implicit coverage
|
|
57
|
-
- Aside from this, follow all checklist llm instructions
|
|
58
|
-
- Mark items as:
|
|
59
|
-
- ✅ PASS: Requirement clearly met
|
|
60
|
-
- ❌ FAIL: Requirement not met or insufficient coverage
|
|
61
|
-
- ⚠️ PARTIAL: Some aspects covered but needs improvement
|
|
62
|
-
- N/A: Not applicable to this case
|
|
63
|
-
|
|
64
|
-
5. **Section Analysis**
|
|
65
|
-
|
|
66
|
-
For each section:
|
|
67
|
-
|
|
68
|
-
- think step by step to calculate pass rate
|
|
69
|
-
- Identify common themes in failed items
|
|
70
|
-
- Provide specific recommendations for improvement
|
|
71
|
-
- In interactive mode, discuss findings with user
|
|
72
|
-
- Document any user decisions or explanations
|
|
73
|
-
|
|
74
|
-
6. **Final Report**
|
|
75
|
-
|
|
76
|
-
Prepare a summary that includes:
|
|
77
|
-
|
|
78
|
-
- Overall checklist completion status
|
|
79
|
-
- Pass rates by section
|
|
80
|
-
- List of failed items with context
|
|
81
|
-
- Specific recommendations for improvement
|
|
82
|
-
- Any sections or items marked as N/A with justification
|
|
83
|
-
|
|
84
|
-
## Checklist Execution Methodology
|
|
85
|
-
|
|
86
|
-
Each checklist now contains embedded LLM prompts and instructions that will:
|
|
87
|
-
|
|
88
|
-
1. **Guide thorough thinking** - Prompts ensure deep analysis of each section
|
|
89
|
-
2. **Request specific artifacts** - Clear instructions on what documents/access is needed
|
|
90
|
-
3. **Provide contextual guidance** - Section-specific prompts for better validation
|
|
91
|
-
4. **Generate comprehensive reports** - Final summary with detailed findings
|
|
92
|
-
|
|
93
|
-
The LLM will:
|
|
94
|
-
|
|
95
|
-
- Execute the complete checklist validation
|
|
96
|
-
- Present a final report with pass/fail rates and key findings
|
|
97
|
-
- Offer to provide detailed analysis of any section, especially those with warnings or failures
|