@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,140 +0,0 @@
|
|
|
1
|
-
# /facilitate-brainstorming-session Task
|
|
2
|
-
|
|
3
|
-
When this command is used, execute the following task:
|
|
4
|
-
|
|
5
|
-
---
|
|
6
|
-
docOutputLocation: docs/brainstorming-session-results.md
|
|
7
|
-
template: ".bmad-core/templates/brainstorming-output-tmpl.yaml"
|
|
8
|
-
---
|
|
9
|
-
|
|
10
|
-
# Facilitate Brainstorming Session Task
|
|
11
|
-
|
|
12
|
-
Facilitate interactive brainstorming sessions with users. Be creative and adaptive in applying techniques.
|
|
13
|
-
|
|
14
|
-
## Process
|
|
15
|
-
|
|
16
|
-
### Step 1: Session Setup
|
|
17
|
-
|
|
18
|
-
Ask 4 context questions (don't preview what happens next):
|
|
19
|
-
|
|
20
|
-
1. What are we brainstorming about?
|
|
21
|
-
2. Any constraints or parameters?
|
|
22
|
-
3. Goal: broad exploration or focused ideation?
|
|
23
|
-
4. Do you want a structured document output to reference later? (Default Yes)
|
|
24
|
-
|
|
25
|
-
### Step 2: Present Approach Options
|
|
26
|
-
|
|
27
|
-
After getting answers to Step 1, present 4 approach options (numbered):
|
|
28
|
-
|
|
29
|
-
1. User selects specific techniques
|
|
30
|
-
2. Analyst recommends techniques based on context
|
|
31
|
-
3. Random technique selection for creative variety
|
|
32
|
-
4. Progressive technique flow (start broad, narrow down)
|
|
33
|
-
|
|
34
|
-
### Step 3: Execute Techniques Interactively
|
|
35
|
-
|
|
36
|
-
**KEY PRINCIPLES:**
|
|
37
|
-
|
|
38
|
-
- **FACILITATOR ROLE**: Guide user to generate their own ideas through questions, prompts, and examples
|
|
39
|
-
- **CONTINUOUS ENGAGEMENT**: Keep user engaged with chosen technique until they want to switch or are satisfied
|
|
40
|
-
- **CAPTURE OUTPUT**: If (default) document output requested, capture all ideas generated in each technique section to the document from the beginning.
|
|
41
|
-
|
|
42
|
-
**Technique Selection:**
|
|
43
|
-
If user selects Option 1, present numbered list of techniques from the brainstorming-techniques data file. User can select by number..
|
|
44
|
-
|
|
45
|
-
**Technique Execution:**
|
|
46
|
-
|
|
47
|
-
1. Apply selected technique according to data file description
|
|
48
|
-
2. Keep engaging with technique until user indicates they want to:
|
|
49
|
-
- Choose a different technique
|
|
50
|
-
- Apply current ideas to a new technique
|
|
51
|
-
- Move to convergent phase
|
|
52
|
-
- End session
|
|
53
|
-
|
|
54
|
-
**Output Capture (if requested):**
|
|
55
|
-
For each technique used, capture:
|
|
56
|
-
|
|
57
|
-
- Technique name and duration
|
|
58
|
-
- Key ideas generated by user
|
|
59
|
-
- Insights and patterns identified
|
|
60
|
-
- User's reflections on the process
|
|
61
|
-
|
|
62
|
-
### Step 4: Session Flow
|
|
63
|
-
|
|
64
|
-
1. **Warm-up** (5-10 min) - Build creative confidence
|
|
65
|
-
2. **Divergent** (20-30 min) - Generate quantity over quality
|
|
66
|
-
3. **Convergent** (15-20 min) - Group and categorize ideas
|
|
67
|
-
4. **Synthesis** (10-15 min) - Refine and develop concepts
|
|
68
|
-
|
|
69
|
-
### Step 5: Document Output (if requested)
|
|
70
|
-
|
|
71
|
-
Generate structured document with these sections:
|
|
72
|
-
|
|
73
|
-
**Executive Summary**
|
|
74
|
-
|
|
75
|
-
- Session topic and goals
|
|
76
|
-
- Techniques used and duration
|
|
77
|
-
- Total ideas generated
|
|
78
|
-
- Key themes and patterns identified
|
|
79
|
-
|
|
80
|
-
**Technique Sections** (for each technique used)
|
|
81
|
-
|
|
82
|
-
- Technique name and description
|
|
83
|
-
- Ideas generated (user's own words)
|
|
84
|
-
- Insights discovered
|
|
85
|
-
- Notable connections or patterns
|
|
86
|
-
|
|
87
|
-
**Idea Categorization**
|
|
88
|
-
|
|
89
|
-
- **Immediate Opportunities** - Ready to implement now
|
|
90
|
-
- **Future Innovations** - Requires development/research
|
|
91
|
-
- **Moonshots** - Ambitious, transformative concepts
|
|
92
|
-
- **Insights & Learnings** - Key realizations from session
|
|
93
|
-
|
|
94
|
-
**Action Planning**
|
|
95
|
-
|
|
96
|
-
- Top 3 priority ideas with rationale
|
|
97
|
-
- Next steps for each priority
|
|
98
|
-
- Resources/research needed
|
|
99
|
-
- Timeline considerations
|
|
100
|
-
|
|
101
|
-
**Reflection & Follow-up**
|
|
102
|
-
|
|
103
|
-
- What worked well in this session
|
|
104
|
-
- Areas for further exploration
|
|
105
|
-
- Recommended follow-up techniques
|
|
106
|
-
- Questions that emerged for future sessions
|
|
107
|
-
|
|
108
|
-
## Key Principles
|
|
109
|
-
|
|
110
|
-
- **YOU ARE A FACILITATOR**: Guide the user to brainstorm, don't brainstorm for them (unless they request it persistently)
|
|
111
|
-
- **INTERACTIVE DIALOGUE**: Ask questions, wait for responses, build on their ideas
|
|
112
|
-
- **ONE TECHNIQUE AT A TIME**: Don't mix multiple techniques in one response
|
|
113
|
-
- **CONTINUOUS ENGAGEMENT**: Stay with one technique until user wants to switch
|
|
114
|
-
- **DRAW IDEAS OUT**: Use prompts and examples to help them generate their own ideas
|
|
115
|
-
- **REAL-TIME ADAPTATION**: Monitor engagement and adjust approach as needed
|
|
116
|
-
- Maintain energy and momentum
|
|
117
|
-
- Defer judgment during generation
|
|
118
|
-
- Quantity leads to quality (aim for 100 ideas in 60 minutes)
|
|
119
|
-
- Build on ideas collaboratively
|
|
120
|
-
- Document everything in output document
|
|
121
|
-
|
|
122
|
-
## Advanced Engagement Strategies
|
|
123
|
-
|
|
124
|
-
**Energy Management**
|
|
125
|
-
|
|
126
|
-
- Check engagement levels: "How are you feeling about this direction?"
|
|
127
|
-
- Offer breaks or technique switches if energy flags
|
|
128
|
-
- Use encouraging language and celebrate idea generation
|
|
129
|
-
|
|
130
|
-
**Depth vs. Breadth**
|
|
131
|
-
|
|
132
|
-
- Ask follow-up questions to deepen ideas: "Tell me more about that..."
|
|
133
|
-
- Use "Yes, and..." to build on their ideas
|
|
134
|
-
- Help them make connections: "How does this relate to your earlier idea about...?"
|
|
135
|
-
|
|
136
|
-
**Transition Management**
|
|
137
|
-
|
|
138
|
-
- Always ask before switching techniques: "Ready to try a different approach?"
|
|
139
|
-
- Offer options: "Should we explore this idea deeper or generate more alternatives?"
|
|
140
|
-
- Respect their process and timing
|
|
@@ -1,55 +0,0 @@
|
|
|
1
|
-
# /generate-ai-frontend-prompt Task
|
|
2
|
-
|
|
3
|
-
When this command is used, execute the following task:
|
|
4
|
-
|
|
5
|
-
# Create AI Frontend Prompt Task
|
|
6
|
-
|
|
7
|
-
## Purpose
|
|
8
|
-
|
|
9
|
-
To generate a masterful, comprehensive, and optimized prompt that can be used with any AI-driven frontend development tool (e.g., Vercel v0, Lovable.ai, or similar) to scaffold or generate significant portions of a frontend application.
|
|
10
|
-
|
|
11
|
-
## Inputs
|
|
12
|
-
|
|
13
|
-
- Completed UI/UX Specification (`front-end-spec.md`)
|
|
14
|
-
- Completed Frontend Architecture Document (`front-end-architecture`) or a full stack combined architecture such as `architecture.md`
|
|
15
|
-
- Main System Architecture Document (`architecture` - for API contracts and tech stack to give further context)
|
|
16
|
-
|
|
17
|
-
## Key Activities & Instructions
|
|
18
|
-
|
|
19
|
-
### 1. Core Prompting Principles
|
|
20
|
-
|
|
21
|
-
Before generating the prompt, you must understand these core principles for interacting with a generative AI for code.
|
|
22
|
-
|
|
23
|
-
- **Be Explicit and Detailed**: The AI cannot read your mind. Provide as much detail and context as possible. Vague requests lead to generic or incorrect outputs.
|
|
24
|
-
- **Iterate, Don't Expect Perfection**: Generating an entire complex application in one go is rare. The most effective method is to prompt for one component or one section at a time, then build upon the results.
|
|
25
|
-
- **Provide Context First**: Always start by providing the AI with the necessary context, such as the tech stack, existing code snippets, and overall project goals.
|
|
26
|
-
- **Mobile-First Approach**: Frame all UI generation requests with a mobile-first design mindset. Describe the mobile layout first, then provide separate instructions for how it should adapt for tablet and desktop.
|
|
27
|
-
|
|
28
|
-
### 2. The Structured Prompting Framework
|
|
29
|
-
|
|
30
|
-
To ensure the highest quality output, you MUST structure every prompt using the following four-part framework.
|
|
31
|
-
|
|
32
|
-
1. **High-Level Goal**: Start with a clear, concise summary of the overall objective. This orients the AI on the primary task.
|
|
33
|
-
- _Example: "Create a responsive user registration form with client-side validation and API integration."_
|
|
34
|
-
2. **Detailed, Step-by-Step Instructions**: Provide a granular, numbered list of actions the AI should take. Break down complex tasks into smaller, sequential steps. This is the most critical part of the prompt.
|
|
35
|
-
- _Example: "1. Create a new file named `RegistrationForm.js`. 2. Use React hooks for state management. 3. Add styled input fields for 'Name', 'Email', and 'Password'. 4. For the email field, ensure it is a valid email format. 5. On submission, call the API endpoint defined below."_
|
|
36
|
-
3. **Code Examples, Data Structures & Constraints**: Include any relevant snippets of existing code, data structures, or API contracts. This gives the AI concrete examples to work with. Crucially, you must also state what _not_ to do.
|
|
37
|
-
- _Example: "Use this API endpoint: `POST /api/register`. The expected JSON payload is `{ "name": "string", "email": "string", "password": "string" }`. Do NOT include a 'confirm password' field. Use Tailwind CSS for all styling."_
|
|
38
|
-
4. **Define a Strict Scope**: Explicitly define the boundaries of the task. Tell the AI which files it can modify and, more importantly, which files to leave untouched to prevent unintended changes across the codebase.
|
|
39
|
-
- _Example: "You should only create the `RegistrationForm.js` component and add it to the `pages/register.js` file. Do NOT alter the `Navbar.js` component or any other existing page or component."_
|
|
40
|
-
|
|
41
|
-
### 3. Assembling the Master Prompt
|
|
42
|
-
|
|
43
|
-
You will now synthesize the inputs and the above principles into a final, comprehensive prompt.
|
|
44
|
-
|
|
45
|
-
1. **Gather Foundational Context**:
|
|
46
|
-
- Start the prompt with a preamble describing the overall project purpose, the full tech stack (e.g., Next.js, TypeScript, Tailwind CSS), and the primary UI component library being used.
|
|
47
|
-
2. **Describe the Visuals**:
|
|
48
|
-
- If the user has design files (Figma, etc.), instruct them to provide links or screenshots.
|
|
49
|
-
- If not, describe the visual style: color palette, typography, spacing, and overall aesthetic (e.g., "minimalist", "corporate", "playful").
|
|
50
|
-
3. **Build the Prompt using the Structured Framework**:
|
|
51
|
-
- Follow the four-part framework from Section 2 to build out the core request, whether it's for a single component or a full page.
|
|
52
|
-
4. **Present and Refine**:
|
|
53
|
-
- Output the complete, generated prompt in a clear, copy-pasteable format (e.g., a large code block).
|
|
54
|
-
- Explain the structure of the prompt and why certain information was included, referencing the principles above.
|
|
55
|
-
- <important_note>Conclude by reminding the user that all AI-generated code will require careful human review, testing, and refinement to be considered production-ready.</important_note>
|
|
@@ -1,182 +0,0 @@
|
|
|
1
|
-
# /index-docs Task
|
|
2
|
-
|
|
3
|
-
When this command is used, execute the following task:
|
|
4
|
-
|
|
5
|
-
# Index Documentation Task
|
|
6
|
-
|
|
7
|
-
## Purpose
|
|
8
|
-
|
|
9
|
-
This task maintains the integrity and completeness of the `docs/index.md` file by scanning all documentation files and ensuring they are properly indexed with descriptions. It handles both root-level documents and documents within subfolders, organizing them hierarchically.
|
|
10
|
-
|
|
11
|
-
## Task Instructions
|
|
12
|
-
|
|
13
|
-
You are now operating as a Documentation Indexer. Your goal is to ensure all documentation files are properly cataloged in the central index with proper organization for subfolders.
|
|
14
|
-
|
|
15
|
-
### Required Steps
|
|
16
|
-
|
|
17
|
-
1. First, locate and scan:
|
|
18
|
-
|
|
19
|
-
- The `docs/` directory and all subdirectories
|
|
20
|
-
- The existing `docs/index.md` file (create if absent)
|
|
21
|
-
- All markdown (`.md`) and text (`.txt`) files in the documentation structure
|
|
22
|
-
- Note the folder structure for hierarchical organization
|
|
23
|
-
|
|
24
|
-
2. For the existing `docs/index.md`:
|
|
25
|
-
|
|
26
|
-
- Parse current entries
|
|
27
|
-
- Note existing file references and descriptions
|
|
28
|
-
- Identify any broken links or missing files
|
|
29
|
-
- Keep track of already-indexed content
|
|
30
|
-
- Preserve existing folder sections
|
|
31
|
-
|
|
32
|
-
3. For each documentation file found:
|
|
33
|
-
|
|
34
|
-
- Extract the title (from first heading or filename)
|
|
35
|
-
- Generate a brief description by analyzing the content
|
|
36
|
-
- Create a relative markdown link to the file
|
|
37
|
-
- Check if it's already in the index
|
|
38
|
-
- Note which folder it belongs to (if in a subfolder)
|
|
39
|
-
- If missing or outdated, prepare an update
|
|
40
|
-
|
|
41
|
-
4. For any missing or non-existent files found in index:
|
|
42
|
-
|
|
43
|
-
- Present a list of all entries that reference non-existent files
|
|
44
|
-
- For each entry:
|
|
45
|
-
- Show the full entry details (title, path, description)
|
|
46
|
-
- Ask for explicit confirmation before removal
|
|
47
|
-
- Provide option to update the path if file was moved
|
|
48
|
-
- Log the decision (remove/update/keep) for final report
|
|
49
|
-
|
|
50
|
-
5. Update `docs/index.md`:
|
|
51
|
-
- Maintain existing structure and organization
|
|
52
|
-
- Create level 2 sections (`##`) for each subfolder
|
|
53
|
-
- List root-level documents first
|
|
54
|
-
- Add missing entries with descriptions
|
|
55
|
-
- Update outdated entries
|
|
56
|
-
- Remove only entries that were confirmed for removal
|
|
57
|
-
- Ensure consistent formatting throughout
|
|
58
|
-
|
|
59
|
-
### Index Structure Format
|
|
60
|
-
|
|
61
|
-
The index should be organized as follows:
|
|
62
|
-
|
|
63
|
-
```markdown
|
|
64
|
-
# Documentation Index
|
|
65
|
-
|
|
66
|
-
## Root Documents
|
|
67
|
-
|
|
68
|
-
### [Document Title](./document.md)
|
|
69
|
-
|
|
70
|
-
Brief description of the document's purpose and contents.
|
|
71
|
-
|
|
72
|
-
### [Another Document](./another.md)
|
|
73
|
-
|
|
74
|
-
Description here.
|
|
75
|
-
|
|
76
|
-
## Folder Name
|
|
77
|
-
|
|
78
|
-
Documents within the `folder-name/` directory:
|
|
79
|
-
|
|
80
|
-
### [Document in Folder](./folder-name/document.md)
|
|
81
|
-
|
|
82
|
-
Description of this document.
|
|
83
|
-
|
|
84
|
-
### [Another in Folder](./folder-name/another.md)
|
|
85
|
-
|
|
86
|
-
Description here.
|
|
87
|
-
|
|
88
|
-
## Another Folder
|
|
89
|
-
|
|
90
|
-
Documents within the `another-folder/` directory:
|
|
91
|
-
|
|
92
|
-
### [Nested Document](./another-folder/document.md)
|
|
93
|
-
|
|
94
|
-
Description of nested document.
|
|
95
|
-
```
|
|
96
|
-
|
|
97
|
-
### Index Entry Format
|
|
98
|
-
|
|
99
|
-
Each entry should follow this format:
|
|
100
|
-
|
|
101
|
-
```markdown
|
|
102
|
-
### [Document Title](relative/path/to/file.md)
|
|
103
|
-
|
|
104
|
-
Brief description of the document's purpose and contents.
|
|
105
|
-
```
|
|
106
|
-
|
|
107
|
-
### Rules of Operation
|
|
108
|
-
|
|
109
|
-
1. NEVER modify the content of indexed files
|
|
110
|
-
2. Preserve existing descriptions in index.md when they are adequate
|
|
111
|
-
3. Maintain any existing categorization or grouping in the index
|
|
112
|
-
4. Use relative paths for all links (starting with `./`)
|
|
113
|
-
5. Ensure descriptions are concise but informative
|
|
114
|
-
6. NEVER remove entries without explicit confirmation
|
|
115
|
-
7. Report any broken links or inconsistencies found
|
|
116
|
-
8. Allow path updates for moved files before considering removal
|
|
117
|
-
9. Create folder sections using level 2 headings (`##`)
|
|
118
|
-
10. Sort folders alphabetically, with root documents listed first
|
|
119
|
-
11. Within each section, sort documents alphabetically by title
|
|
120
|
-
|
|
121
|
-
### Process Output
|
|
122
|
-
|
|
123
|
-
The task will provide:
|
|
124
|
-
|
|
125
|
-
1. A summary of changes made to index.md
|
|
126
|
-
2. List of newly indexed files (organized by folder)
|
|
127
|
-
3. List of updated entries
|
|
128
|
-
4. List of entries presented for removal and their status:
|
|
129
|
-
- Confirmed removals
|
|
130
|
-
- Updated paths
|
|
131
|
-
- Kept despite missing file
|
|
132
|
-
5. Any new folders discovered
|
|
133
|
-
6. Any other issues or inconsistencies found
|
|
134
|
-
|
|
135
|
-
### Handling Missing Files
|
|
136
|
-
|
|
137
|
-
For each file referenced in the index but not found in the filesystem:
|
|
138
|
-
|
|
139
|
-
1. Present the entry:
|
|
140
|
-
|
|
141
|
-
```markdown
|
|
142
|
-
Missing file detected:
|
|
143
|
-
Title: [Document Title]
|
|
144
|
-
Path: relative/path/to/file.md
|
|
145
|
-
Description: Existing description
|
|
146
|
-
Section: [Root Documents | Folder Name]
|
|
147
|
-
|
|
148
|
-
Options:
|
|
149
|
-
|
|
150
|
-
1. Remove this entry
|
|
151
|
-
2. Update the file path
|
|
152
|
-
3. Keep entry (mark as temporarily unavailable)
|
|
153
|
-
|
|
154
|
-
Please choose an option (1/2/3):
|
|
155
|
-
```
|
|
156
|
-
|
|
157
|
-
2. Wait for user confirmation before taking any action
|
|
158
|
-
3. Log the decision for the final report
|
|
159
|
-
|
|
160
|
-
### Special Cases
|
|
161
|
-
|
|
162
|
-
1. **Sharded Documents**: If a folder contains an `index.md` file, treat it as a sharded document:
|
|
163
|
-
|
|
164
|
-
- Use the folder's `index.md` title as the section title
|
|
165
|
-
- List the folder's documents as subsections
|
|
166
|
-
- Note in the description that this is a multi-part document
|
|
167
|
-
|
|
168
|
-
2. **README files**: Convert `README.md` to more descriptive titles based on content
|
|
169
|
-
|
|
170
|
-
3. **Nested Subfolders**: For deeply nested folders, maintain the hierarchy but limit to 2 levels in the main index. Deeper structures should have their own index files.
|
|
171
|
-
|
|
172
|
-
## Required Input
|
|
173
|
-
|
|
174
|
-
Please provide:
|
|
175
|
-
|
|
176
|
-
1. Location of the `docs/` directory (default: `./docs`)
|
|
177
|
-
2. Confirmation of write access to `docs/index.md`
|
|
178
|
-
3. Any specific categorization preferences
|
|
179
|
-
4. Any files or directories to exclude from indexing (e.g., `.git`, `node_modules`)
|
|
180
|
-
5. Whether to include hidden files/folders (starting with `.`)
|
|
181
|
-
|
|
182
|
-
Would you like to proceed with documentation indexing? Please provide the required input above.
|
|
@@ -1,79 +0,0 @@
|
|
|
1
|
-
# /kb-mode-interaction Task
|
|
2
|
-
|
|
3
|
-
When this command is used, execute the following task:
|
|
4
|
-
|
|
5
|
-
# KB Mode Interaction Task
|
|
6
|
-
|
|
7
|
-
## Purpose
|
|
8
|
-
|
|
9
|
-
Provide a user-friendly interface to the BMad knowledge base without overwhelming users with information upfront.
|
|
10
|
-
|
|
11
|
-
## Instructions
|
|
12
|
-
|
|
13
|
-
When entering KB mode (\*kb-mode), follow these steps:
|
|
14
|
-
|
|
15
|
-
### 1. Welcome and Guide
|
|
16
|
-
|
|
17
|
-
Announce entering KB mode with a brief, friendly introduction.
|
|
18
|
-
|
|
19
|
-
### 2. Present Topic Areas
|
|
20
|
-
|
|
21
|
-
Offer a concise list of main topic areas the user might want to explore:
|
|
22
|
-
|
|
23
|
-
**What would you like to know more about?**
|
|
24
|
-
|
|
25
|
-
1. **Setup & Installation** - Getting started with BMad
|
|
26
|
-
2. **Workflows** - Choosing the right workflow for your project
|
|
27
|
-
3. **Web vs IDE** - When to use each environment
|
|
28
|
-
4. **Agents** - Understanding specialized agents and their roles
|
|
29
|
-
5. **Documents** - PRDs, Architecture, Stories, and more
|
|
30
|
-
6. **Agile Process** - How BMad implements Agile methodologies
|
|
31
|
-
7. **Configuration** - Customizing BMad for your needs
|
|
32
|
-
8. **Best Practices** - Tips for effective BMad usage
|
|
33
|
-
|
|
34
|
-
Or ask me about anything else related to BMad-Method!
|
|
35
|
-
|
|
36
|
-
### 3. Respond Contextually
|
|
37
|
-
|
|
38
|
-
- Wait for user's specific question or topic selection
|
|
39
|
-
- Provide focused, relevant information from the knowledge base
|
|
40
|
-
- Offer to dive deeper or explore related topics
|
|
41
|
-
- Keep responses concise unless user asks for detailed explanations
|
|
42
|
-
|
|
43
|
-
### 4. Interactive Exploration
|
|
44
|
-
|
|
45
|
-
- After answering, suggest related topics they might find helpful
|
|
46
|
-
- Maintain conversational flow rather than data dumping
|
|
47
|
-
- Use examples when appropriate
|
|
48
|
-
- Reference specific documentation sections when relevant
|
|
49
|
-
|
|
50
|
-
### 5. Exit Gracefully
|
|
51
|
-
|
|
52
|
-
When user is done or wants to exit KB mode:
|
|
53
|
-
|
|
54
|
-
- Summarize key points discussed if helpful
|
|
55
|
-
- Remind them they can return to KB mode anytime with \*kb-mode
|
|
56
|
-
- Suggest next steps based on what was discussed
|
|
57
|
-
|
|
58
|
-
## Example Interaction
|
|
59
|
-
|
|
60
|
-
**User**: \*kb-mode
|
|
61
|
-
|
|
62
|
-
**Assistant**: I've entered KB mode and have access to the full BMad knowledge base. I can help you with detailed information about any aspect of BMad-Method.
|
|
63
|
-
|
|
64
|
-
**What would you like to know more about?**
|
|
65
|
-
|
|
66
|
-
1. **Setup & Installation** - Getting started with BMad
|
|
67
|
-
2. **Workflows** - Choosing the right workflow for your project
|
|
68
|
-
3. **Web vs IDE** - When to use each environment
|
|
69
|
-
4. **Agents** - Understanding specialized agents and their roles
|
|
70
|
-
5. **Documents** - PRDs, Architecture, Stories, and more
|
|
71
|
-
6. **Agile Process** - How BMad implements Agile methodologies
|
|
72
|
-
7. **Configuration** - Customizing BMad for your needs
|
|
73
|
-
8. **Best Practices** - Tips for effective BMad usage
|
|
74
|
-
|
|
75
|
-
Or ask me about anything else related to BMad-Method!
|
|
76
|
-
|
|
77
|
-
**User**: Tell me about workflows
|
|
78
|
-
|
|
79
|
-
**Assistant**: [Provides focused information about workflows from the KB, then offers to explore specific workflow types or related topics]
|
|
@@ -1,166 +0,0 @@
|
|
|
1
|
-
# /review-story Task
|
|
2
|
-
|
|
3
|
-
When this command is used, execute the following task:
|
|
4
|
-
|
|
5
|
-
# review-story
|
|
6
|
-
|
|
7
|
-
When a developer agent marks a story as "Ready for Review", perform a comprehensive senior developer code review with the ability to refactor and improve code directly.
|
|
8
|
-
|
|
9
|
-
## Prerequisites
|
|
10
|
-
|
|
11
|
-
- Story status must be "Review"
|
|
12
|
-
- Developer has completed all tasks and updated the File List
|
|
13
|
-
- All automated tests are passing
|
|
14
|
-
|
|
15
|
-
## Review Process
|
|
16
|
-
|
|
17
|
-
1. **Read the Complete Story**
|
|
18
|
-
|
|
19
|
-
- Review all acceptance criteria
|
|
20
|
-
- Understand the dev notes and requirements
|
|
21
|
-
- Note any completion notes from the developer
|
|
22
|
-
|
|
23
|
-
2. **Verify Implementation Against Dev Notes Guidance**
|
|
24
|
-
|
|
25
|
-
- Review the "Dev Notes" section for specific technical guidance provided to the developer
|
|
26
|
-
- Verify the developer's implementation follows the architectural patterns specified in Dev Notes
|
|
27
|
-
- Check that file locations match the project structure guidance in Dev Notes
|
|
28
|
-
- Confirm any specified libraries, frameworks, or technical approaches were used correctly
|
|
29
|
-
- Validate that security considerations mentioned in Dev Notes were implemented
|
|
30
|
-
|
|
31
|
-
3. **Focus on the File List**
|
|
32
|
-
|
|
33
|
-
- Verify all files listed were actually created/modified
|
|
34
|
-
- Check for any missing files that should have been updated
|
|
35
|
-
- Ensure file locations align with the project structure guidance from Dev Notes
|
|
36
|
-
|
|
37
|
-
4. **Senior Developer Code Review**
|
|
38
|
-
|
|
39
|
-
- Review code with the eye of a senior developer
|
|
40
|
-
- If changes form a cohesive whole, review them together
|
|
41
|
-
- If changes are independent, review incrementally file by file
|
|
42
|
-
- Focus on:
|
|
43
|
-
- Code architecture and design patterns
|
|
44
|
-
- Refactoring opportunities
|
|
45
|
-
- Code duplication or inefficiencies
|
|
46
|
-
- Performance optimizations
|
|
47
|
-
- Security concerns
|
|
48
|
-
- Best practices and patterns
|
|
49
|
-
|
|
50
|
-
5. **Active Refactoring**
|
|
51
|
-
|
|
52
|
-
- As a senior developer, you CAN and SHOULD refactor code where improvements are needed
|
|
53
|
-
- When refactoring:
|
|
54
|
-
- Make the changes directly in the files
|
|
55
|
-
- Explain WHY you're making the change
|
|
56
|
-
- Describe HOW the change improves the code
|
|
57
|
-
- Ensure all tests still pass after refactoring
|
|
58
|
-
- Update the File List if you modify additional files
|
|
59
|
-
|
|
60
|
-
6. **Standards Compliance Check**
|
|
61
|
-
|
|
62
|
-
- Verify adherence to `docs/coding-standards.md`
|
|
63
|
-
- Check compliance with `docs/unified-project-structure.md`
|
|
64
|
-
- Validate testing approach against `docs/testing-strategy.md`
|
|
65
|
-
- Ensure all guidelines mentioned in the story are followed
|
|
66
|
-
|
|
67
|
-
7. **Acceptance Criteria Validation**
|
|
68
|
-
|
|
69
|
-
- Verify each AC is fully implemented
|
|
70
|
-
- Check for any missing functionality
|
|
71
|
-
- Validate edge cases are handled
|
|
72
|
-
|
|
73
|
-
8. **Test Coverage Review**
|
|
74
|
-
|
|
75
|
-
- Ensure unit tests cover edge cases
|
|
76
|
-
- Add missing tests if critical coverage is lacking
|
|
77
|
-
- Verify integration tests (if required) are comprehensive
|
|
78
|
-
- Check that test assertions are meaningful
|
|
79
|
-
- Look for missing test scenarios
|
|
80
|
-
|
|
81
|
-
9. **Documentation and Comments**
|
|
82
|
-
- Verify code is self-documenting where possible
|
|
83
|
-
- Add comments for complex logic if missing
|
|
84
|
-
- Ensure any API changes are documented
|
|
85
|
-
|
|
86
|
-
## Update Story File - QA Results Section ONLY
|
|
87
|
-
|
|
88
|
-
**CRITICAL**: You are ONLY authorized to update the "QA Results" section of the story file. DO NOT modify any other sections.
|
|
89
|
-
|
|
90
|
-
After review and any refactoring, append your results to the story file in the QA Results section:
|
|
91
|
-
|
|
92
|
-
```markdown
|
|
93
|
-
## QA Results
|
|
94
|
-
|
|
95
|
-
### Review Date: [Date]
|
|
96
|
-
|
|
97
|
-
### Reviewed By: Quinn (Senior Developer QA)
|
|
98
|
-
|
|
99
|
-
### Code Quality Assessment
|
|
100
|
-
|
|
101
|
-
[Overall assessment of implementation quality]
|
|
102
|
-
|
|
103
|
-
### Refactoring Performed
|
|
104
|
-
|
|
105
|
-
[List any refactoring you performed with explanations]
|
|
106
|
-
|
|
107
|
-
- **File**: [filename]
|
|
108
|
-
- **Change**: [what was changed]
|
|
109
|
-
- **Why**: [reason for change]
|
|
110
|
-
- **How**: [how it improves the code]
|
|
111
|
-
|
|
112
|
-
### Compliance Check
|
|
113
|
-
|
|
114
|
-
- Coding Standards: [✓/✗] [notes if any]
|
|
115
|
-
- Project Structure: [✓/✗] [notes if any]
|
|
116
|
-
- Testing Strategy: [✓/✗] [notes if any]
|
|
117
|
-
- All ACs Met: [✓/✗] [notes if any]
|
|
118
|
-
|
|
119
|
-
### Improvements Checklist
|
|
120
|
-
|
|
121
|
-
[Check off items you handled yourself, leave unchecked for dev to address]
|
|
122
|
-
|
|
123
|
-
- [x] Refactored user service for better error handling (services/user.service.ts)
|
|
124
|
-
- [x] Added missing edge case tests (services/user.service.test.ts)
|
|
125
|
-
- [ ] Consider extracting validation logic to separate validator class
|
|
126
|
-
- [ ] Add integration test for error scenarios
|
|
127
|
-
- [ ] Update API documentation for new error codes
|
|
128
|
-
|
|
129
|
-
### Security Review
|
|
130
|
-
|
|
131
|
-
[Any security concerns found and whether addressed]
|
|
132
|
-
|
|
133
|
-
### Performance Considerations
|
|
134
|
-
|
|
135
|
-
[Any performance issues found and whether addressed]
|
|
136
|
-
|
|
137
|
-
### Final Status
|
|
138
|
-
|
|
139
|
-
[✓ Approved - Ready for Done] / [✗ Changes Required - See unchecked items above]
|
|
140
|
-
```
|
|
141
|
-
|
|
142
|
-
## Key Principles
|
|
143
|
-
|
|
144
|
-
- You are a SENIOR developer reviewing junior/mid-level work
|
|
145
|
-
- You have the authority and responsibility to improve code directly
|
|
146
|
-
- Always explain your changes for learning purposes
|
|
147
|
-
- Balance between perfection and pragmatism
|
|
148
|
-
- Focus on significant improvements, not nitpicks
|
|
149
|
-
|
|
150
|
-
## Blocking Conditions
|
|
151
|
-
|
|
152
|
-
Stop the review and request clarification if:
|
|
153
|
-
|
|
154
|
-
- Story file is incomplete or missing critical sections
|
|
155
|
-
- File List is empty or clearly incomplete
|
|
156
|
-
- No tests exist when they were required
|
|
157
|
-
- Code changes don't align with story requirements
|
|
158
|
-
- Critical architectural issues that require discussion
|
|
159
|
-
|
|
160
|
-
## Completion
|
|
161
|
-
|
|
162
|
-
After review:
|
|
163
|
-
|
|
164
|
-
1. If all items are checked and approved: Update story status to "Done"
|
|
165
|
-
2. If unchecked items remain: Keep status as "Review" for dev to address
|
|
166
|
-
3. Always provide constructive feedback and explanations for learning
|