This commit is contained in:
DevForgeAI 2025-06-07 20:34:52 -04:00
parent 0479413153
commit fb02de7d2e
29 changed files with 536 additions and 532 deletions

4
.gitignore vendored
View File

@ -17,3 +17,7 @@ build/
.env
CLAUDE.md
Clean-EscapedBackticks.ps1
#Enhancements
Enhancements/

View File

@ -1,4 +1,4 @@
# v0 UX/UI Architect Training Materials
# v0 UX/UI Architect Training Materials
## Quick Start Guide
@ -6,9 +6,9 @@
To activate Veronica in a web-based AI environment:
\`\`\`
```
"I need to work with Veronica, the v0 UX/UI Architect. I want to create [describe your UI/UX need]."
\`\`\`
```
### Core Capabilities
@ -22,24 +22,24 @@ Veronica excels at:
### Common Use Cases
#### 1. Creating a New Component
\`\`\`
```
"Veronica, I need a modern card component for displaying product information.
It should include an image, title, price, and call-to-action button.
The design should be clean and work well on mobile."
\`\`\`
```
#### 2. Building a Design System
\`\`\`
```
"Veronica, help me create a design system for a fintech application.
I need primary and secondary buttons, form inputs, and cards.
The brand colors are blue (#2563eb) and gray (#64748b)."
\`\`\`
```
#### 3. Rapid Prototyping
\`\`\`
```
"Veronica, I have a project brief for an e-commerce dashboard.
Can you create initial wireframes and component mockups based on the requirements?"
\`\`\`
```
### Best Practices

View File

@ -1,11 +1,11 @@
# v0 UX/UI Architect Example Project
# v0 UX/UI Architect Example Project
## Project Overview
**Project**: E-commerce Product Dashboard
**Goal**: Create a modern, responsive dashboard for managing products
**Target Users**: Store administrators and product managers
## Phase 1: Initial Requirements (Analyst v0 UX/UI Architect)
## Phase 1: Initial Requirements (Analyst → v0 UX/UI Architect)
### Project Brief Summary
- Need a dashboard for managing e-commerce products
@ -17,11 +17,11 @@
## Phase 2: Component Creation with Veronica
### Activation Prompt
\`\`\`
```
"Veronica, I need your help creating a product dashboard for an e-commerce platform.
Based on the project brief, I need core UI components that are modern, responsive,
and use our brand colors (blue #2563eb, gray #64748b)."
\`\`\`
```
### Generated Components
@ -33,7 +33,7 @@ and use our brand colors (blue #2563eb, gray #64748b)."
- Accessible design with proper ARIA labels
**Implementation:**
\`\`\`tsx
```tsx
interface ProductCardProps {
product: {
id: string;
@ -49,7 +49,7 @@ interface ProductCardProps {
const ProductCard: React.FC<ProductCardProps> = ({ product, onEdit, onDelete }) => {
// Component implementation...
};
\`\`\`
```
#### 2. Dashboard Header Component
**Specification:**
@ -69,32 +69,32 @@ const ProductCard: React.FC<ProductCardProps> = ({ product, onEdit, onDelete })
### v0 Component Quality Checklist Applied
**Design Consistency**
✅ **Design Consistency**
- Follows established design system patterns
- Color palette matches brand guidelines (#2563eb, #64748b)
- Typography scales appropriately
- Spacing follows 8px grid system
**Code Quality**
✅ **Code Quality**
- Components are properly typed (TypeScript)
- Props are well-documented with interfaces
- Components handle edge cases (loading, error states)
- Performance optimized with React.memo where appropriate
**Accessibility**
✅ **Accessibility**
- Semantic HTML structure (header, main, section)
- Proper ARIA labels and roles
- Keyboard navigation support (tab order, enter/space activation)
- Screen reader compatibility tested
- Color contrast meets WCAG AA standards (4.5:1 ratio)
**Responsive Design**
✅ **Responsive Design**
- Mobile-first approach implemented
- Breakpoints: 640px (sm), 768px (md), 1024px (lg)
- Touch-friendly interaction areas (44px minimum)
- Content reflows appropriately on all screen sizes
**Integration**
✅ **Integration**
- Imports/exports properly configured
- Dependencies clearly documented (React, TypeScript, Tailwind)
- Integration examples provided
@ -103,26 +103,26 @@ const ProductCard: React.FC<ProductCardProps> = ({ product, onEdit, onDelete })
## Phase 4: Implementation Results
### File Structure Created
\`\`\`
```
src/
├── components/
│ ├── ProductCard/
│ │ ├── ProductCard.tsx
│ │ ├── ProductCard.stories.tsx
│ │ └── ProductCard.test.tsx
│ ├── DashboardHeader/
│ │ ├── DashboardHeader.tsx
│ │ ├── DashboardHeader.stories.tsx
│ │ └── DashboardHeader.test.tsx
│ └── DataTable/
│ ├── DataTable.tsx
│ ├── DataTable.stories.tsx
│ └── DataTable.test.tsx
├── types/
│ └── Product.ts
└── styles/
└── components.css
\`\`\`
├── components/
│ ├── ProductCard/
│ │ ├── ProductCard.tsx
│ │ ├── ProductCard.stories.tsx
│ │ └── ProductCard.test.tsx
│ ├── DashboardHeader/
│ │ ├── DashboardHeader.tsx
│ │ ├── DashboardHeader.stories.tsx
│ │ └── DashboardHeader.test.tsx
│ └── DataTable/
│ ├── DataTable.tsx
│ ├── DataTable.stories.tsx
│ └── DataTable.test.tsx
├── types/
│ └── Product.ts
└── styles/
└── components.css
```
### Performance Metrics
- **Lighthouse Score**: 98/100

View File

@ -1,4 +1,4 @@
# Role: DevOps and Platform Engineering Agent
# Role: DevOps and Platform Engineering Agent
`taskroot`: `bmad-agent/tasks/`
`Debug Log`: `.ai/infrastructure-changes.md`
@ -70,12 +70,12 @@ When responding to requests, gather essential context first:
For implementation scenarios, summarize key context:
\`\`\`plaintext
```plaintext
[Environment] Multi-cloud, multi-region, brownfield
[Stack] Microservices, event-driven, containerized
[Constraints] SOC2 compliance, 3-month timeline
[Challenge] Consistent infrastructure with compliance
\`\`\`
```
## Core Operational Mandates

View File

@ -1,4 +1,4 @@
# Advanced Elicitation Task
# Advanced Elicitation Task
## Purpose
@ -14,7 +14,7 @@
**Present the numbered list (0-9) with this exact format:**
\`\`\`
```
**Advanced Reflective, Elicitation & Brainstorming Actions**
Choose an action (0-9 - 9 to bypass - HELP for explanation of these options):
@ -28,7 +28,7 @@ Choose an action (0-9 - 9 to bypass - HELP for explanation of these options):
7. Explore Diverse Alternatives (ToT-Inspired)
8. Hindsight is 20/20: The 'If Only...' Reflection
9. Proceed / No Further Actions
\`\`\`
```
### 2. Processing Guidelines

View File

@ -1,4 +1,4 @@
# Create Next Story Task
# Create Next Story Task
## Purpose
@ -33,7 +33,7 @@ To identify the next logical story based on project progress and epic definition
- Verify its `Status` is 'Done' (or equivalent).
- If not 'Done', present an alert to the user:
\`\`\`plaintext
```plaintext
ALERT: Found incomplete story:
File: {lastEpicNum}.{lastStoryNum}.story.md
Status: [current status]
@ -44,7 +44,7 @@ To identify the next logical story based on project progress and epic definition
3. Accept risk & Override to create the next story in draft
Please choose an option (1/2/3):
\`\`\`
```
- Proceed only if user selects option 3 (Override) or if the last story was 'Done'.
- If proceeding: Check the Epic File for `{lastEpicNum}` for a story numbered `{lastStoryNum + 1}`. If it exists and its prerequisites (per Epic File) are met, this is the next story.

View File

@ -1,4 +1,4 @@
# Library Indexing Task
# Library Indexing Task
## Purpose
@ -51,11 +51,11 @@ You are now operating as a Documentation Indexer. Your goal is to ensure all doc
Each entry in `docs/index.md` should follow this format:
\`\`\`markdown
```markdown
### [Document Title](relative/path/to/file.md)
Brief description of the document's purpose and contents.
\`\`\`
```
### Rules of Operation
@ -87,7 +87,7 @@ For each file referenced in the index but not found in the filesystem:
1. Present the entry:
\`\`\`markdown
```markdown
Missing file detected:
Title: [Document Title]
Path: relative/path/to/file.md
@ -100,7 +100,7 @@ For each file referenced in the index but not found in the filesystem:
3. Keep entry (mark as temporarily unavailable)
Please choose an option (1/2/3):
\`\`\`
```
2. Wait for user confirmation before taking any action
3. Log the decision for the final report

View File

@ -1,4 +1,4 @@
# {Project Name} Architecture Document
# {Project Name} Architecture Document
## Introduction / Preamble
@ -45,47 +45,47 @@ If the project includes a significant user interface, a separate Frontend Archit
{Provide an ASCII or Mermaid diagram representing the project's folder structure. The following is a general example. If a `front-end-architecture-tmpl.txt` (or equivalent) is in use, it will contain the detailed structure for the frontend portion (e.g., within `src/frontend/` or a dedicated `frontend/` root directory). Shared code structure (e.g., in a `packages/` directory for a monorepo) should also be detailed here.}
\`\`\`plaintext
```plaintext
{project-root}/
├── .github/ # CI/CD workflows (e.g., GitHub Actions)
│ └── workflows/
│ └── main.yml
├── .vscode/ # VSCode settings (optional)
│ └── settings.json
├── build/ # Compiled output (if applicable, often git-ignored)
├── config/ # Static configuration files (if any)
├── docs/ # Project documentation (PRD, Arch, etc.)
│ ├── index.md
│ └── ... (other .md files)
├── infra/ # Infrastructure as Code (e.g., CDK, Terraform)
│ └── lib/
│ └── bin/
├── node_modules/ / venv / target/ # Project dependencies (git-ignored)
├── scripts/ # Utility scripts (build, deploy helpers, etc.)
├── src/ # Application source code
│ ├── backend/ # Backend-specific application code (if distinct frontend exists)
│ │ ├── core/ # Core business logic, domain models
│ │ ├── services/ # Business services, orchestrators
│ │ ├── adapters/ # Adapters to external systems (DB, APIs)
│ │ ├── controllers/ / routes/ # API endpoint handlers
│ │ └── main.ts / app.py # Backend application entry point
│ ├── frontend/ # Placeholder: See Frontend Architecture Doc for details if used
│ ├── shared/ / common/ # Code shared (e.g., types, utils, domain models if applicable)
│ │ └── types/
│ └── main.ts / index.ts / app.ts # Main application entry point (if not using backend/frontend split above)
├── stories/ # Generated story files for development (optional)
│ └── epic1/
├── test/ # Automated tests
│ ├── unit/ # Unit tests (mirroring src structure)
│ ├── integration/ # Integration tests
│ └── e2e/ # End-to-end tests
├── .env.example # Example environment variables
├── .gitignore # Git ignore rules
├── package.json / requirements.txt / pom.xml # Project manifest and dependencies
├── tsconfig.json / pyproject.toml # Language-specific configuration (if applicable)
├── Dockerfile # Docker build instructions (if applicable)
└── README.md # Project overview and setup instructions
\`\`\`
├── .github/ # CI/CD workflows (e.g., GitHub Actions)
│ └── workflows/
│ └── main.yml
├── .vscode/ # VSCode settings (optional)
│ └── settings.json
├── build/ # Compiled output (if applicable, often git-ignored)
├── config/ # Static configuration files (if any)
├── docs/ # Project documentation (PRD, Arch, etc.)
│ ├── index.md
│ └── ... (other .md files)
├── infra/ # Infrastructure as Code (e.g., CDK, Terraform)
│ └── lib/
│ └── bin/
├── node_modules/ / venv / target/ # Project dependencies (git-ignored)
├── scripts/ # Utility scripts (build, deploy helpers, etc.)
├── src/ # Application source code
│ ├── backend/ # Backend-specific application code (if distinct frontend exists)
│ │ ├── core/ # Core business logic, domain models
│ │ ├── services/ # Business services, orchestrators
│ │ ├── adapters/ # Adapters to external systems (DB, APIs)
│ │ ├── controllers/ / routes/ # API endpoint handlers
│ │ └── main.ts / app.py # Backend application entry point
│ ├── frontend/ # Placeholder: See Frontend Architecture Doc for details if used
│ ├── shared/ / common/ # Code shared (e.g., types, utils, domain models if applicable)
│ │ └── types/
│ └── main.ts / index.ts / app.ts # Main application entry point (if not using backend/frontend split above)
├── stories/ # Generated story files for development (optional)
│ └── epic1/
├── test/ # Automated tests
│ ├── unit/ # Unit tests (mirroring src structure)
│ ├── integration/ # Integration tests
│ └── e2e/ # End-to-end tests
├── .env.example # Example environment variables
├── .gitignore # Git ignore rules
├── package.json / requirements.txt / pom.xml # Project manifest and dependencies
├── tsconfig.json / pyproject.toml # Language-specific configuration (if applicable)
├── Dockerfile # Docker build instructions (if applicable)
└── README.md # Project overview and setup instructions
```
(Adjust the example tree based on the actual project type - e.g., Python would have requirements.txt, etc. The structure above illustrates a potential separation for projects with distinct frontends; for simpler projects or APIs, the `src/` structure might be flatter.)
@ -157,7 +157,7 @@ If the project includes a significant user interface, a separate Frontend Archit
- **Description:** {What does this entity represent?}
- **Schema / Interface Definition:**
\`\`\`typescript
```typescript
// Example using TypeScript Interface
export interface {EntityName} {
id: string; // {Description, e.g., Unique identifier}
@ -165,7 +165,7 @@ If the project includes a significant user interface, a separate Frontend Archit
optionalProperty?: number; // {Description}
// ... other properties
}
\`\`\`
```
- **Validation Rules:** {List any specific validation rules beyond basic types - e.g., max length, format, range.}
### API Payload Schemas (If distinct)
@ -175,14 +175,14 @@ If the project includes a significant user interface, a separate Frontend Archit
#### {API Endpoint / Purpose, e.g., Create Order Request, repeat the section as needed}
- **Schema / Interface Definition:**
\`\`\`typescript
```typescript
// Example
export interface CreateOrderRequest {
customerId: string;
items: { productId: string; quantity: number }[];
// ...
}
\`\`\`
```
### Database Schemas (If applicable)
@ -192,7 +192,7 @@ If the project includes a significant user interface, a separate Frontend Archit
- **Purpose:** {What data does this table store?}
- **Schema Definition:**
\`\`\`sql
```sql
-- Example SQL
CREATE TABLE {TableName} (
id VARCHAR(36) PRIMARY KEY,
@ -200,7 +200,7 @@ If the project includes a significant user interface, a separate Frontend Archit
numeric_column DECIMAL(10, 2),
-- ... other columns, indexes, constraints
);
\`\`\`
```
_(Alternatively, use ORM model definitions, NoSQL document structure, etc.)_
## Core Workflow / Sequence Diagrams

View File

@ -1,4 +1,4 @@
# {Project Name} Frontend Architecture Document
# {Project Name} Frontend Architecture Document
## Table of Contents
@ -51,7 +51,7 @@
- **Framework & Core Libraries:** {e.g., React 18.x with Next.js 13.x, Angular 16.x, Vue 3.x with Nuxt.js}. **These are derived from the 'Definitive Tech Stack Selections' in the main Architecture Document.** This section elaborates on *how* these choices are applied specifically to the frontend.
- **Component Architecture:** {e.g., Atomic Design principles, Presentational vs. Container components, use of specific component libraries like Material UI, Tailwind CSS for styling approach. Specify chosen approach and any key libraries.}
- **State Management Strategy:** {e.g., Redux Toolkit, Zustand, Vuex, NgRx. Briefly describe the overall approach global store, feature stores, context API usage. **Referenced from main Architecture Document and detailed further in "State Management In-Depth" section.**}
- **State Management Strategy:** {e.g., Redux Toolkit, Zustand, Vuex, NgRx. Briefly describe the overall approach – global store, feature stores, context API usage. **Referenced from main Architecture Document and detailed further in "State Management In-Depth" section.**}
- **Data Flow:** {e.g., Unidirectional data flow (Flux/Redux pattern), React Query/SWR for server state. Describe how data is fetched, cached, passed to components, and updated.}
- **Styling Approach:** **{Chosen Styling Solution, e.g., Tailwind CSS / CSS Modules / Styled Components}**. Configuration File(s): {e.g., `tailwind.config.js`, `postcss.config.js`}. Key conventions: {e.g., "Utility-first approach for Tailwind. Custom components defined in `src/styles/components.css`. Theme extensions in `tailwind.config.js` under `theme.extend`. For CSS Modules, files are co-located with components, e.g., `MyComponent.module.css`.}
- **Key Design Patterns Used:** {e.g., Provider pattern, Hooks, Higher-Order Components, Service patterns for API calls, Container/Presentational. These patterns are to be consistently applied. Deviations require justification and documentation.}
@ -62,46 +62,46 @@
### EXAMPLE - Not Prescriptive (for a React/Next.js app)
\`\`\`plaintext
```plaintext
src/
├── app/ # Next.js App Router: Pages/Layouts/Routes. MUST contain route segments, layouts, and page components.
│ ├── (features)/ # Feature-based routing groups. MUST group related routes for a specific feature.
│ │ └── dashboard/
│ │ ├── layout.tsx # Layout specific to the dashboard feature routes.
│ │ └── page.tsx # Entry page component for a dashboard route.
│ ├── api/ # API Routes (if using Next.js backend features). MUST contain backend handlers for client-side calls.
│ ├── globals.css # Global styles. MUST contain base styles, CSS variable definitions, Tailwind base/components/utilities.
│ └── layout.tsx # Root layout for the entire application.
├── components/ # Shared/Reusable UI Components.
│ ├── ui/ # Base UI elements (Button, Input, Card). MUST contain only generic, reusable, presentational UI elements, often mapped from a design system. MUST NOT contain business logic.
│ │ ├── Button.tsx
│ │ └── ...
│ ├── layout/ # Layout components (Header, Footer, Sidebar). MUST contain components structuring page layouts, not specific page content.
│ │ ├── Header.tsx
│ │ └── ...
│ └── (feature-specific)/ # Components specific to a feature but potentially reusable within it. This is an alternative to co-locating within features/ directory.
│ └── user-profile/
│ └── ProfileCard.tsx
├── features/ # Feature-specific logic, hooks, non-global state, services, and components solely used by that feature.
│ └── auth/
│ ├── components/ # Components used exclusively by the auth feature. MUST NOT be imported by other features.
│ ├── hooks/ # Custom React Hooks specific to the 'auth' feature. Hooks reusable across features belong in `src/hooks/`.
│ ├── services/ # Feature-specific API interactions or orchestrations for the 'auth' feature.
│ └── store.ts # Feature-specific state slice (e.g., Redux slice) if not part of a global store or if local state is complex.
├── hooks/ # Global/sharable custom React Hooks. MUST be generic and usable by multiple features/components.
│ └── useAuth.ts
├── lib/ / utils/ # Utility functions, helpers, constants. MUST contain pure functions and constants, no side effects or framework-specific code unless clearly named (e.g., `react-helpers.ts`).
│ └── utils.ts
├── services/ # Global API service clients or SDK configurations. MUST define base API client instances and core data fetching/mutation services.
│ └── apiClient.ts
├── store/ # Global state management setup (e.g., Redux store, Zustand store).
│ ├── index.ts # Main store configuration and export.
│ ├── rootReducer.ts # Root reducer if using Redux.
│ └── (slices)/ # Directory for global state slices (if not co-located in features).
├── styles/ # Global styles, theme configurations (if not using `globals.css` or similar, or for specific styling systems like SCSS partials).
└── types/ # Global TypeScript type definitions/interfaces. MUST contain types shared across multiple features/modules.
└── index.ts
\`\`\`
├── app/ # Next.js App Router: Pages/Layouts/Routes. MUST contain route segments, layouts, and page components.
│ ├── (features)/ # Feature-based routing groups. MUST group related routes for a specific feature.
│ │ └── dashboard/
│ │ ├── layout.tsx # Layout specific to the dashboard feature routes.
│ │ └── page.tsx # Entry page component for a dashboard route.
│ ├── api/ # API Routes (if using Next.js backend features). MUST contain backend handlers for client-side calls.
│ ├── globals.css # Global styles. MUST contain base styles, CSS variable definitions, Tailwind base/components/utilities.
│ └── layout.tsx # Root layout for the entire application.
├── components/ # Shared/Reusable UI Components.
│ ├── ui/ # Base UI elements (Button, Input, Card). MUST contain only generic, reusable, presentational UI elements, often mapped from a design system. MUST NOT contain business logic.
│ │ ├── Button.tsx
│ │ └── ...
│ ├── layout/ # Layout components (Header, Footer, Sidebar). MUST contain components structuring page layouts, not specific page content.
│ │ ├── Header.tsx
│ │ └── ...
│ └── (feature-specific)/ # Components specific to a feature but potentially reusable within it. This is an alternative to co-locating within features/ directory.
│ └── user-profile/
│ └── ProfileCard.tsx
├── features/ # Feature-specific logic, hooks, non-global state, services, and components solely used by that feature.
│ └── auth/
│ ├── components/ # Components used exclusively by the auth feature. MUST NOT be imported by other features.
│ ├── hooks/ # Custom React Hooks specific to the 'auth' feature. Hooks reusable across features belong in `src/hooks/`.
│ ├── services/ # Feature-specific API interactions or orchestrations for the 'auth' feature.
│ └── store.ts # Feature-specific state slice (e.g., Redux slice) if not part of a global store or if local state is complex.
├── hooks/ # Global/sharable custom React Hooks. MUST be generic and usable by multiple features/components.
│ └── useAuth.ts
├── lib/ / utils/ # Utility functions, helpers, constants. MUST contain pure functions and constants, no side effects or framework-specific code unless clearly named (e.g., `react-helpers.ts`).
│ └── utils.ts
├── services/ # Global API service clients or SDK configurations. MUST define base API client instances and core data fetching/mutation services.
│ └── apiClient.ts
├── store/ # Global state management setup (e.g., Redux store, Zustand store).
│ ├── index.ts # Main store configuration and export.
│ ├── rootReducer.ts # Root reducer if using Redux.
│ └── (slices)/ # Directory for global state slices (if not co-located in features).
├── styles/ # Global styles, theme configurations (if not using `globals.css` or similar, or for specific styling systems like SCSS partials).
└── types/ # Global TypeScript type definitions/interfaces. MUST contain types shared across multiple features/modules.
└── index.ts
```
### Notes on Frontend Structure:
@ -142,14 +142,14 @@ src/
| `{anotherState}`| `{type}` | `{value}` | {Description of state variable and its purpose.} |
- **Key UI Elements / Structure:**
{ Provide a pseudo-HTML or JSX-like structure representing the component\'s DOM. Include key conditional rendering logic if applicable. **This structure dictates the primary output for the AI agent.** }
\`\`\`html
```html
<div> <!-- Main card container with specific class e.g., styles.cardFull or styles.cardCompact based on variant prop -->
<img src="{avatarUrl || defaultAvatar}" alt="User Avatar" class="{styles.avatar}" />
<h2>{userName}</h2>
<p class="{variant === 'full' ? styles.emailFull : styles.emailCompact}">{userEmail}</p>
{variant === 'full' && onEdit && <button onClick={onEdit} class="{styles.editButton}">Edit</button>}
</div>
\`\`\`
```
- **Events Handled / Emitted:**
- **Handles:** {e.g., `onClick` on the edit button (triggers `onEdit` prop).}
- **Emits:** {If the component emits custom events/callbacks not covered by props, describe them with their exact signature. e.g., `onFollow: (payload: { userId: string; followed: boolean }) => void`}
@ -184,7 +184,7 @@ _Repeat the above template for each significant component._
- **Core Slice Example (e.g., `sessionSlice` in `src/store/slices/sessionSlice.ts`):**
- **Purpose:** {Manages user session, authentication status, and basic user profile info accessible globally.}
- **State Shape (Interface/Type):**
\`\`\`typescript
```typescript
interface SessionState {
currentUser: { id: string; name: string; email: string; roles: string[]; } | null;
isAuthenticated: boolean;
@ -192,7 +192,7 @@ _Repeat the above template for each significant component._
status: "idle" | "loading" | "succeeded" | "failed";
error: string | null;
}
\`\`\`
```
- **Key Reducers/Actions (within `createSlice`):** {Briefly list main synchronous actions, e.g., `setCurrentUser`, `clearSession`, `setAuthStatus`, `setAuthError`.}
- **Async Thunks (if any):** {List key async thunks, e.g., `loginUserThunk`, `fetchUserProfileThunk`.}
- **Selectors (memoized with `createSelector`):** {List key selectors, e.g., `selectCurrentUser`, `selectIsAuthenticated`.}

View File

@ -1,4 +1,4 @@
# {Project Name} UI/UX Specification
# {Project Name} UI/UX Specification
## Introduction
@ -16,14 +16,14 @@
## Information Architecture (IA)
- **Site Map / Screen Inventory:**
\`\`\`mermaid
```mermaid
graph TD
A[Homepage] --> B(Dashboard);
A --> C{Settings};
B --> D[View Details];
C --> E[Profile Settings];
C --> F[Notification Settings];
\`\`\`
```
_(Or provide a list of all screens/pages)_
- **Navigation Structure:** {Describe primary navigation (e.g., top bar, sidebar), secondary navigation, breadcrumbs, etc.}
@ -35,7 +35,7 @@
- **Goal:** {What the user wants to achieve.}
- **Steps / Diagram:**
\`\`\`mermaid
```mermaid
graph TD
Start --> EnterCredentials[Enter Email/Password];
EnterCredentials --> ClickLogin[Click Login Button];
@ -43,7 +43,7 @@
CheckAuth -- Yes --> Dashboard;
CheckAuth -- No --> ShowError[Show Error Message];
ShowError --> EnterCredentials;
\`\`\`
```
_(Or: Link to specific flow diagram in Figma/Miro)_
### {Another User Flow Name}

View File

@ -1,20 +1,20 @@
# IDE Component Structure Template
# IDE Component Structure Template
## File Structure
\`\`\`
```
{component-name}/
├── index.ts # Main export file
├── {component-name}.tsx # Component implementation
├── {component-name}.test.tsx # Component tests
├── {component-name}.module.css # Component styles (if using CSS modules)
├── {component-name}.stories.tsx # Storybook stories (if applicable)
└── types.ts # TypeScript types (if complex enough to warrant separation)
\`\`\`
├── index.ts # Main export file
├── {component-name}.tsx # Component implementation
├── {component-name}.test.tsx # Component tests
├── {component-name}.module.css # Component styles (if using CSS modules)
├── {component-name}.stories.tsx # Storybook stories (if applicable)
└── types.ts # TypeScript types (if complex enough to warrant separation)
```
## Component Implementation File ({component-name}.tsx)
\`\`\`tsx
```tsx
import React from 'react';
import styles from './{component-name}.module.css'; // If using CSS modules
@ -47,11 +47,11 @@ export const {ComponentName} = ({
};
export default {ComponentName};
\`\`\`
```
## Test File ({component-name}.test.tsx)
\`\`\`tsx
```tsx
import React from 'react';
import { render, screen, fireEvent } from '@testing-library/react';
import { {ComponentName} } from './{component-name}';
@ -71,11 +71,11 @@ describe('{ComponentName}', () => {
// Additional tests
});
\`\`\`
```
## Storybook File ({component-name}.stories.tsx)
\`\`\`tsx
```tsx
import type { Meta, StoryObj } from '@storybook/react';
import { {ComponentName} } from './{component-name}';
@ -107,28 +107,28 @@ export const Variant: Story = {
};
// Additional stories
\`\`\`
```
## Index File (index.ts)
\`\`\`tsx
```tsx
export { {ComponentName} } from './{component-name}';
export type { {ComponentName}Props } from './types'; // If using separate types file
\`\`\`
```
## Types File (types.ts) - If needed
\`\`\`tsx
```tsx
export interface {ComponentName}Props {
// Props definition
}
// Additional types
\`\`\`
```
## Usage Example
\`\`\`tsx
```tsx
import { {ComponentName} } from 'components/{component-name}';
const MyPage = () => {

View File

@ -1,4 +1,4 @@
# Component Specification: {Component Name}
# Component Specification: {Component Name}
## Overview
**Purpose:** {Brief description of component purpose}
@ -41,36 +41,36 @@
## Implementation Code
### Component Structure
\`\`\`tsx
```tsx
// Component structure code
\`\`\`
```
### Styling
\`\`\`tsx
```tsx
// Styling code
\`\`\`
```
### Logic
\`\`\`tsx
```tsx
// Logic code
\`\`\`
```
## Usage Examples
### Basic Usage
\`\`\`tsx
```tsx
// Basic usage example
\`\`\`
```
### With Variants
\`\`\`tsx
```tsx
// Variant examples
\`\`\`
```
### With Different States
\`\`\`tsx
```tsx
// State examples
\`\`\`
```
## Testing Checklist
- [ ] Visual regression tests

View File

@ -1,4 +1,4 @@
# Setting Up v0-UX/UI Architect in Claude Code
# Setting Up v0-UX/UI Architect in Claude Code
This guide will help you set up and use the v0-UX/UI Architect persona in Claude Code for efficient frontend development.
@ -7,10 +7,10 @@ This guide will help you set up and use the v0-UX/UI Architect persona in Claude
### 1. Initial Setup
1. **Clone the BMAD-Method Repository**
\`\`\`bash
```bash
git clone https://github.com/bmadcode/BMAD-METHOD.git
cd BMAD-METHOD
\`\`\`
```
2. **Open in Claude Code**
- Launch Claude Code
@ -48,47 +48,47 @@ For optimal results, provide the following context:
### Basic Component Creation
1. **Simple Component Request**
\`\`\`
```
Create a responsive card component with:
- Image
- Title
- Description
- Action button
\`\`\`
```
2. **Component with Variants**
\`\`\`
```
Create a button component with:
- Primary, secondary, and tertiary variants
- Different sizes (sm, md, lg)
- Loading state
- Disabled state
\`\`\`
```
### Advanced Usage
1. **Design System Integration**
\`\`\`
```
Create a modal component that follows our existing design system.
It should have a header, body, footer, and close button.
\`\`\`
```
2. **Multi-Component Creation**
\`\`\`
```
Create a form with:
- Text input
- Dropdown select
- Checkbox group
- Submit button
All components should be reusable and follow accessibility best practices.
\`\`\`
```
3. **Code Quality Focus**
Claude Code excels at code quality. Try:
\`\`\`
```
Create a data table component with sorting, filtering, and pagination.
Ensure it follows best practices for performance and accessibility.
\`\`\`
```
### Claude Code-Specific Tips

View File

@ -1,4 +1,4 @@
# Setting Up v0-UX/UI Architect in Cline (Claude Dev)
# Setting Up v0-UX/UI Architect in Cline (Claude Dev)
This guide will help you set up and use the v0-UX/UI Architect persona in Cline for efficient frontend development.
@ -7,10 +7,10 @@ This guide will help you set up and use the v0-UX/UI Architect persona in Cline
### 1. Initial Setup
1. **Clone the BMAD-Method Repository**
\`\`\`bash
```bash
git clone https://github.com/bmadcode/BMAD-METHOD.git
cd BMAD-METHOD
\`\`\`
```
2. **Open in Cline**
- Launch Cline
@ -48,46 +48,46 @@ For optimal results, provide the following context:
### Basic Component Creation
1. **Simple Component Request**
\`\`\`
```
Create a responsive card component with:
- Image
- Title
- Description
- Action button
\`\`\`
```
2. **Component with Variants**
\`\`\`
```
Create a button component with:
- Primary, secondary, and tertiary variants
- Different sizes (sm, md, lg)
- Loading state
- Disabled state
\`\`\`
```
### Advanced Usage
1. **Design System Integration**
\`\`\`
```
Create a modal component that follows our existing design system.
It should have a header, body, footer, and close button.
\`\`\`
```
2. **Multi-Component Creation**
\`\`\`
```
Create a form with:
- Text input
- Dropdown select
- Checkbox group
- Submit button
All components should be reusable and follow accessibility best practices.
\`\`\`
```
3. **Terminal Integration**
Cline excels at terminal integration. Try:
\`\`\`
```
Help me set up a new component library with Storybook integration.
\`\`\`
```
### Cline-Specific Tips

View File

@ -1,4 +1,4 @@
# Setting Up v0-UX/UI Architect in Cursor AI
# Setting Up v0-UX/UI Architect in Cursor AI
This guide will help you set up and use the v0-UX/UI Architect persona in Cursor AI for efficient frontend development.
@ -7,10 +7,10 @@ This guide will help you set up and use the v0-UX/UI Architect persona in Cursor
### 1. Initial Setup
1. **Clone the BMAD-Method Repository**
\`\`\`bash
```bash
git clone https://github.com/bmadcode/BMAD-METHOD.git
cd BMAD-METHOD
\`\`\`
```
2. **Open in Cursor AI**
- Launch Cursor AI
@ -39,13 +39,13 @@ This guide will help you set up and use the v0-UX/UI Architect persona in Cursor
For optimal results, provide the following context:
1. **Project Structure Overview**
\`\`\`
```
/src
/components
/styles
/pages
package.json
\`\`\`
```
2. **Tech Stack Information**
- Frontend framework (React, Vue, etc.)
@ -58,46 +58,46 @@ For optimal results, provide the following context:
### Basic Component Creation
1. **Simple Component Request**
\`\`\`
```
Create a responsive card component with:
- Image
- Title
- Description
- Action button
\`\`\`
```
2. **Component with Variants**
\`\`\`
```
Create a button component with:
- Primary, secondary, and tertiary variants
- Different sizes (sm, md, lg)
- Loading state
- Disabled state
\`\`\`
```
### Advanced Usage
1. **Design System Integration**
\`\`\`
```
Create a modal component that follows our existing design system.
It should have a header, body, footer, and close button.
\`\`\`
```
2. **Multi-Component Creation**
\`\`\`
```
Create a form with:
- Text input
- Dropdown select
- Checkbox group
- Submit button
All components should be reusable and follow accessibility best practices.
\`\`\`
```
3. **Component Refactoring**
\`\`\`
```
Refactor this existing component to use Tailwind CSS and improve performance:
[paste component code]
\`\`\`
```
### Cursor-Specific Tips

View File

@ -1,4 +1,4 @@
# Setting Up v0-UX/UI Architect in Roocode
# Setting Up v0-UX/UI Architect in Roocode
This guide will help you set up and use the v0-UX/UI Architect persona in Roocode for efficient frontend development.
@ -7,10 +7,10 @@ This guide will help you set up and use the v0-UX/UI Architect persona in Roocod
### 1. Initial Setup
1. **Clone the BMAD-Method Repository**
\`\`\`bash
```bash
git clone https://github.com/bmadcode/BMAD-METHOD.git
cd BMAD-METHOD
\`\`\`
```
2. **Open in Roocode**
- Launch Roocode
@ -48,46 +48,46 @@ For optimal results, provide the following context:
### Basic Component Creation
1. **Simple Component Request**
\`\`\`
```
Create a responsive card component with:
- Image
- Title
- Description
- Action button
\`\`\`
```
2. **Component with Variants**
\`\`\`
```
Create a button component with:
- Primary, secondary, and tertiary variants
- Different sizes (sm, md, lg)
- Loading state
- Disabled state
\`\`\`
```
### Advanced Usage
1. **Design System Integration**
\`\`\`
```
Create a modal component that follows our existing design system.
It should have a header, body, footer, and close button.
\`\`\`
```
2. **Multi-Component Creation**
\`\`\`
```
Create a form with:
- Text input
- Dropdown select
- Checkbox group
- Submit button
All components should be reusable and follow accessibility best practices.
\`\`\`
```
3. **Rapid Prototyping**
Roocode excels at rapid prototyping. Try:
\`\`\`
```
Create a dashboard layout with navigation, stats cards, and a data table.
\`\`\`
```
### Roocode-Specific Tips

View File

@ -1,4 +1,4 @@
# Instructions
# Instructions
- [Setting up Web Agent Orchestrator](#setting-up-web-agent-orchestrator)
- [IDE Agent Setup and Usage](#ide-agent-setup-and-usage)
@ -53,7 +53,7 @@ NOTE the build will skip any files with the `.ide.<extension>` - so you can have
1. ```cmd
node build-web-agent.js
\`\`\`
```
The script will log its progress, including discovered source directories, any issues found (like duplicate base filenames), and the output files being generated.
@ -89,18 +89,18 @@ While `build-bmad-orchestrator.js` packages assets, the Orchestrator's core beha
`checklists`, `templates`, `data`, `tasks`: These keys introduce lists of resources the agent will have access to. Each item is a Markdown link under the respective key, for example:
For `checklists`:
\`\`\`markdown
```markdown
- checklists:
- [Pm Checklist](checklists#pm-checklist)
- [Another Checklist](checklists#another-one)
\`\`\`
```
For `tasks`:
\`\`\`markdown
```markdown
- tasks:
- [Create Prd](tasks#create-prd)
\`\`\`
```
These references (e.g., `checklists#pm-checklist` or `tasks#create-prd`) point to sections in bundled asset files, providing the agent with its knowledge and tools. Note: `data` is used (not `data_sources`), and `tasks` is used (not `available_tasks` from older documentation styles).
@ -133,7 +133,7 @@ You can use specialized standalone IDE agents, such as the `sm.ide.md` (Scrum Ma
### IDE Agent Orchestrator (`ide-bmad-orchestrator.md`)
A powerful alternative is the `ide-bmad-orchestrator.md`. This agent provides the flexibility of the web orchestrator—allowing a single IDE agent to embody multiple personas—but **without requiring any build step.** It dynamically loads its configuration and all associated resources.
A powerful alternative is the `ide-bmad-orchestrator.md`. This agent provides the flexibility of the web orchestrator—allowing a single IDE agent to embody multiple personas—but **without requiring any build step.** It dynamically loads its configuration and all associated resources.
#### How the IDE Orchestrator Works
@ -143,7 +143,7 @@ A powerful alternative is the `ide-bmad-orchestrator.md`. This agent provides th
- **Data Resolution:**
Located at the top of the config file, this section defines key-value pairs for base paths. These paths tell the orchestrator where to find different types of asset files (personas, tasks, checklists, templates, data).
\`\`\`markdown
```markdown
# Configuration for IDE Agents
## Data Resolution
@ -157,7 +157,7 @@ A powerful alternative is the `ide-bmad-orchestrator.md`. This agent provides th
NOTE: All Persona references and task markdown style links assume these data resolution paths unless a specific path is given.
Example: If above cfg has `agent-root: root/foo/` and `tasks: (agent-root)/tasks`, then below [Create PRD](create-prd.md) would resolve to `root/foo/tasks/create-prd.md`
\`\`\`
```
The `(project-root)` placeholder is typically interpreted as the root of your current workspace.
@ -175,7 +175,7 @@ A powerful alternative is the `ide-bmad-orchestrator.md`. This agent provides th
- The link target is either a Markdown filename for an external task definition (e.g., `(create-prd.md)`), resolved using the `tasks:` path, or a special string like `(In Analyst Memory Already)` indicating the task logic is part of the persona's main definition.
Example:
\`\`\`markdown
```markdown
## Title: Product Owner AKA PO
- Name: Curly
@ -183,7 +183,7 @@ A powerful alternative is the `ide-bmad-orchestrator.md`. This agent provides th
- Tasks:
- [Create PRD](create-prd.md)
- [Create Next Story](create-next-story-task.md)
\`\`\`
```
2. **Operational Workflow (inside `ide-bmad-orchestrator.md`):**
- **Initialization:** Upon activation in your IDE, the `ide-bmad-orchestrator.md` first loads and parses its specified configuration file (`ide-bmad-orchestrator.cfg.md`). If this fails, it will inform you and halt.

View File

@ -1,4 +1,4 @@
# IDE Environment Quick Start Guide
# IDE Environment Quick Start Guide
## 5-Minute Setup for v0 UX/UI Architect in IDEs
@ -8,13 +8,13 @@
- Basic frontend project setup (React, Vue, etc.)
### Step 1: Prepare Your Project
\`\`\`bash
```bash
# Copy BMAD Method files to your project
cp -r /path/to/bmad-agent ./bmad-agent
# Ensure your project has the necessary dependencies
npm install # or yarn install
\`\`\`
```
### Step 2: Activate Victor in Your IDE
@ -29,7 +29,7 @@ npm install # or yarn install
3. Specify your implementation needs
### Step 3: Request Component Implementation
\`\`\`
```
Victor, I need you to implement a responsive product card component using React and Tailwind CSS.
Requirements:
@ -42,7 +42,7 @@ Requirements:
- TypeScript interfaces
Please create all necessary files and update imports.
\`\`\`
```
### Step 4: Review Generated Files
Victor will create:
@ -53,35 +53,35 @@ Victor will create:
- Test file (if testing framework detected)
### Step 5: Test and Iterate
\`\`\`
```
The component looks great! Can you add a wishlist button and make the image lazy-loaded?
\`\`\`
```
## IDE-Specific Workflows
### Cursor AI Workflow
\`\`\`
```
Victor, analyze my existing component structure and create a new SearchBar component
that follows the same patterns. It should integrate with our existing design system.
\`\`\`
```
### Cline Workflow
\`\`\`
```
I need you to refactor this existing component to use our new design tokens.
Also add proper error handling and loading states.
\`\`\`
```
### Claude Code Workflow
\`\`\`
```
Create a comprehensive form component with validation, error handling,
and accessibility features. Follow our coding standards and include tests.
\`\`\`
```
### Roocode Workflow
\`\`\`
```
Let's rapidly prototype a dashboard layout with multiple widget types.
Create the basic structure and we'll iterate on the details.
\`\`\`
```
## Best Practices for IDE Usage
@ -103,18 +103,18 @@ Create the basic structure and we'll iterate on the details.
## Troubleshooting
### "Victor doesn't understand my project structure"
\`\`\`
```
Victor, please analyze my project structure first. Look at the existing components
in src/components/ and follow the same patterns for file organization and naming.
\`\`\`
```
### "Generated code doesn't match our standards"
\`\`\`
```
Please review our ESLint configuration and coding standards in .eslintrc.js
and ensure the generated code follows these rules.
\`\`\`
```
### "Components don't integrate properly"
\`\`\`
```
Check the existing component imports in src/components/index.ts and update
the exports to include the new component.

View File

@ -1,4 +1,4 @@
# Web Environment Quick Start Guide
# Web Environment Quick Start Guide
## 5-Minute Setup for v0 UX/UI Architect
@ -13,19 +13,19 @@
4. **Save the configuration**
### Step 2: Activate Veronica
\`\`\`
```
I need Veronica, the v0 UX/UI Architect, to help me create a modern dashboard component.
\`\`\`
```
### Step 3: Provide Your Requirements
\`\`\`
```
I'm building a SaaS application dashboard that needs:
- A sidebar navigation with menu items
- A main content area for widgets
- A top header with user profile and notifications
- Responsive design for mobile and desktop
- Modern, clean aesthetic using a blue and white color scheme
\`\`\`
```
### Step 4: Review the Output
Veronica will provide:
@ -35,33 +35,33 @@ Veronica will provide:
- Accessibility considerations
### Step 5: Iterate and Refine
\`\`\`
```
Can you modify the sidebar to be collapsible and add a dark mode variant?
\`\`\`
```
## Common Web Environment Workflows
### Design Exploration
\`\`\`
```
Veronica, I need to explore different design directions for a product landing page.
Can you create 3 different layout concepts with different visual styles?
\`\`\`
```
### Component Specification
\`\`\`
```
I need a detailed specification for a data table component that includes:
- Sortable columns
- Row selection
- Pagination
- Search functionality
- Export options
\`\`\`
```
### Design System Planning
\`\`\`
```
Veronica, help me plan a design system for a fintech application.
I need core components, color palette, typography scale, and spacing tokens.
\`\`\`
```
## Tips for Success
- Be specific about your technical requirements

View File

@ -1,4 +1,4 @@
# Using the v0 UX/UI Architect with Claude Code
# Using the v0 UX/UI Architect with Claude Code
This guide provides specific instructions for using the v0 UX/UI IDE Architect persona within Claude Code.
@ -15,12 +15,12 @@ This guide provides specific instructions for using the v0 UX/UI IDE Architect p
1. Start a new conversation in Claude Code
2. Enter the following prompt:
\`\`\`
```
I want to work with the v0 UX/UI IDE Architect from the BMAD Method.
My name is Victor and I'm specialized in direct implementation of
frontend components in IDE environments with a focus on code quality,
testability, and integration with existing codebases.
\`\`\`
```
3. The AI will acknowledge and adopt the persona
@ -29,55 +29,55 @@ testability, and integration with existing codebases.
### Component Creation Workflow
1. **Project Analysis**:
\`\`\`
```
Please analyze my project to understand our component architecture,
styling approach, and existing patterns.
\`\`\`
```
2. **Component Planning**:
\`\`\`
```
I need to create a complex Dashboard component with multiple widgets,
data visualization, and interactive elements. Let's plan the component
structure before implementation.
\`\`\`
```
3. **Implementation**:
\`\`\`
```
Based on our plan, let's implement the Dashboard component and its
child components, focusing on maintainability and performance.
\`\`\`
```
4. **Styling**:
\`\`\`
```
Now let's style the Dashboard component according to our design system,
ensuring it's responsive and visually consistent with our application.
\`\`\`
```
5. **Testing**:
\`\`\`
```
Please create comprehensive tests for the Dashboard component,
including unit tests, integration tests, and visual regression tests.
\`\`\`
```
### Design System Implementation
1. **Design Token Implementation**:
\`\`\`
```
I need to implement our design tokens in a way that supports
theming and can be used across our application.
\`\`\`
```
2. **Component Library Setup**:
\`\`\`
```
Let's set up a component library structure that will allow us
to maintain and document our design system components.
\`\`\`
```
3. **Core Component Creation**:
\`\`\`
```
Let's implement the core components of our design system:
Typography, Button, Input, Card, and Modal.
\`\`\`
```
## Claude Code-Specific Features
@ -85,31 +85,31 @@ testability, and integration with existing codebases.
Claude Code excels at generating high-quality, well-structured code:
\`\`\`
```
Please generate a complete, production-ready Accordion component
that follows accessibility best practices and supports keyboard navigation.
\`\`\`
```
### Documentation Generation
Leverage Claude Code's documentation capabilities:
\`\`\`
```
Please create comprehensive documentation for our Button component,
including props, examples, accessibility notes, and best practices.
\`\`\`
```
### Code Review
Use Claude Code for code review and improvement:
\`\`\`
```
Please review this component and suggest improvements for:
1. Performance optimization
2. Accessibility
3. Code organization
4. Error handling
\`\`\`
```
## Tips for Best Results
@ -139,7 +139,7 @@ Please review this component and suggest improvements for:
Here's an example of a complete session with the v0 UX/UI Architect in Claude Code:
\`\`\`
```
User: I want to work with the v0 UX/UI IDE Architect from the BMAD Method.
AI: I'll embody the v0 UX/UI IDE Architect persona. I'm Victor, specialized in direct implementation of frontend components with a focus on code quality, testability, and integration with existing codebases. How can I help with your frontend implementation today?
@ -175,7 +175,7 @@ User: Can you also show how we would test this component?
AI: Here's a comprehensive testing strategy:
[Creates test files with various test cases and scenarios]
\`\`\`
```
## Conclusion

View File

@ -1,4 +1,4 @@
# Using the v0 UX/UI Architect with Cline (Claude Dev)
# Using the v0 UX/UI Architect with Cline (Claude Dev)
This guide provides specific instructions for using the v0 UX/UI IDE Architect persona within Cline (formerly Claude Dev).
@ -15,12 +15,12 @@ This guide provides specific instructions for using the v0 UX/UI IDE Architect p
1. Open a new chat in Cline
2. Enter the following prompt:
\`\`\`
```
I want to work with the v0 UX/UI IDE Architect from the BMAD Method.
My name is Victor and I'm specialized in direct implementation of
frontend components in IDE environments with a focus on code quality,
testability, and integration with existing codebases.
\`\`\`
```
3. The AI will acknowledge and adopt the persona
@ -29,54 +29,54 @@ testability, and integration with existing codebases.
### Component Creation Workflow
1. **Analyze Project Structure**:
\`\`\`
```
Please analyze my project structure to understand our component organization,
styling approach, and existing patterns.
\`\`\`
```
2. **Create Component Files**:
\`\`\`
```
I need to create a DataTable component that supports sorting, filtering,
and pagination. Please create the necessary files following our project structure.
\`\`\`
```
3. **Implement Component Logic**:
\`\`\`
```
Now let's implement the core logic for the DataTable component,
focusing on the sorting and filtering functionality.
\`\`\`
```
4. **Add Styling**:
\`\`\`
```
Let's style the DataTable component according to our design system.
It should be responsive and support both light and dark themes.
\`\`\`
```
5. **Create Tests**:
\`\`\`
```
Please create comprehensive tests for the DataTable component,
covering all key functionality and edge cases.
\`\`\`
```
### Design System Implementation
1. **Analyze Existing Design System**:
\`\`\`
```
Please analyze our current design system implementation and suggest
improvements for consistency and maintainability.
\`\`\`
```
2. **Implement Design Tokens**:
\`\`\`
```
I need to implement our design tokens as CSS variables or a ThemeProvider,
depending on our project setup.
\`\`\`
```
3. **Create Component Library**:
\`\`\`
```
Let's create a core set of components that implement our design system:
Button, Input, Card, and Modal.
\`\`\`
```
## Cline-Specific Features
@ -84,28 +84,28 @@ testability, and integration with existing codebases.
Cline has excellent file system awareness. Use this to your advantage:
\`\`\`
```
Please scan our src/components directory and identify any inconsistencies
in our component implementation patterns.
\`\`\`
```
### Code Analysis
Leverage Cline's code understanding capabilities:
\`\`\`
```
Can you analyze this component and suggest improvements for performance,
accessibility, and maintainability?
\`\`\`
```
### Terminal Integration
Use Cline's terminal integration for package management:
\`\`\`
```
I need to add a date picker to our project. Please recommend a library
that fits our needs and show me how to install and integrate it.
\`\`\`
```
## Tips for Best Results
@ -135,7 +135,7 @@ that fits our needs and show me how to install and integrate it.
Here's an example of a complete session with the v0 UX/UI Architect in Cline:
\`\`\`
```
User: I want to work with the v0 UX/UI IDE Architect from the BMAD Method.
AI: I'll embody the v0 UX/UI IDE Architect persona. I'm Victor, specialized in direct implementation of frontend components with a focus on code quality, testability, and integration with existing codebases. How can I help with your frontend implementation today?
@ -165,7 +165,7 @@ User: Can you also show me how to test these components for accessibility?
AI: Here's how to test these components for accessibility:
[Creates test files with accessibility testing]
\`\`\`
```
## Conclusion

View File

@ -1,4 +1,4 @@
# Using the v0 UX/UI Architect with Cursor AI
# Using the v0 UX/UI Architect with Cursor AI
This guide provides specific instructions for using the v0 UX/UI IDE Architect persona within Cursor AI.
@ -7,7 +7,7 @@ This guide provides specific instructions for using the v0 UX/UI IDE Architect p
1. **Install Cursor AI**: Download and install from [cursor.sh](https://cursor.sh)
2. **Open Your Project**: Launch Cursor AI and open your frontend project
3. **Configure AI Settings**:
- Open Settings (⚙️)
- Open Settings (⚙️)
- Navigate to AI settings
- Ensure you're using the most capable model available
@ -16,12 +16,12 @@ This guide provides specific instructions for using the v0 UX/UI IDE Architect p
1. Open the AI command palette (Cmd/Ctrl + Shift + L)
2. Enter the following prompt:
\`\`\`
```
I want to work with the v0 UX/UI IDE Architect from the BMAD Method.
My name is Victor and I'm specialized in direct implementation of
frontend components in IDE environments with a focus on code quality,
testability, and integration with existing codebases.
\`\`\`
```
3. The AI will acknowledge and adopt the persona
@ -30,51 +30,51 @@ testability, and integration with existing codebases.
### Component Creation Workflow
1. **Create Component Files**:
\`\`\`
```
I need to create a ProductCard component for our e-commerce site.
It should display product image, title, price, rating, and have
"Add to Cart" and "Quick View" actions. Please create the necessary
files following our project structure.
\`\`\`
```
2. **Implement Component Logic**:
\`\`\`
```
Now let's implement the logic for the ProductCard component.
It should handle loading states, error states, and user interactions.
\`\`\`
```
3. **Style the Component**:
\`\`\`
```
Let's style the ProductCard component using our Tailwind setup.
It should be responsive and match our design system.
\`\`\`
```
4. **Add Tests**:
\`\`\`
```
Please create tests for the ProductCard component to ensure
it renders correctly and handles user interactions properly.
\`\`\`
```
### Design System Implementation
1. **Create Design Tokens**:
\`\`\`
```
I need to implement our design tokens in code. We use CSS variables
for colors, spacing, typography, and shadows. Here are our token values:
[paste design token values]
\`\`\`
```
2. **Create Base Components**:
\`\`\`
```
Let's create our base Button component that will support all our
variants: primary, secondary, tertiary, and ghost.
\`\`\`
```
3. **Document Components**:
\`\`\`
```
Please create documentation for our Button component using JSDoc
or Storybook, depending on our project setup.
\`\`\`
```
## Cursor AI-Specific Features
@ -82,7 +82,7 @@ testability, and integration with existing codebases.
Cursor AI excels at creating and modifying multiple files at once. Use this to your advantage:
\`\`\`
```
I need to create a complete form system with the following components:
- TextInput
- Select
@ -91,25 +91,25 @@ I need to create a complete form system with the following components:
- Form
Please create all necessary files and implement them according to our design system.
\`\`\`
```
### Code Explanation
Use Cursor AI to explain complex code:
\`\`\`
```
Can you explain how this component works and suggest improvements
for performance and accessibility?
\`\`\`
```
### Refactoring
Leverage Cursor AI for refactoring:
\`\`\`
```
This component has grown too complex. Can you refactor it into
smaller, more manageable components while maintaining the same functionality?
\`\`\`
```
## Tips for Best Results
@ -139,7 +139,7 @@ smaller, more manageable components while maintaining the same functionality?
Here's an example of a complete session with the v0 UX/UI Architect in Cursor AI:
\`\`\`
```
User: I want to work with the v0 UX/UI IDE Architect from the BMAD Method.
AI: I'll embody the v0 UX/UI IDE Architect persona. I'm Victor, specialized in direct implementation of frontend components with a focus on code quality, testability, and integration with existing codebases. How can I help with your frontend implementation today?
@ -169,7 +169,7 @@ User: Perfect! Can you also add tests for this component?
AI: I'll create comprehensive tests for the Navigation component:
[Creates test files with various test cases]
\`\`\`
```
## Conclusion

View File

@ -1,4 +1,4 @@
# Using the v0 UX/UI Architect with Roocode
# Using the v0 UX/UI Architect with Roocode
This guide provides specific instructions for using the v0 UX/UI IDE Architect persona within Roocode.
@ -15,12 +15,12 @@ This guide provides specific instructions for using the v0 UX/UI IDE Architect p
1. Open the AI assistant in Roocode
2. Enter the following prompt:
\`\`\`
```
I want to work with the v0 UX/UI IDE Architect from the BMAD Method.
My name is Victor and I'm specialized in direct implementation of
frontend components in IDE environments with a focus on code quality,
testability, and integration with existing codebases.
\`\`\`
```
3. The AI will acknowledge and adopt the persona
@ -29,55 +29,55 @@ testability, and integration with existing codebases.
### Component Creation Workflow
1. **Project Setup**:
\`\`\`
```
I'm starting a new frontend project. Let's set up a React application
with TypeScript, Tailwind CSS, and a component-based architecture.
\`\`\`
```
2. **Component Planning**:
\`\`\`
```
I need to create a comprehensive e-commerce product page with product
details, image gallery, reviews, and related products. Let's plan the
component structure.
\`\`\`
```
3. **Implementation**:
\`\`\`
```
Let's implement the ProductDetail component first, focusing on the
product information display and purchase options.
\`\`\`
```
4. **Styling**:
\`\`\`
```
Now let's style the ProductDetail component using Tailwind CSS,
ensuring it's responsive and visually appealing.
\`\`\`
```
5. **Interactive Features**:
\`\`\`
```
Let's add interactive features to the product page, such as image zoom,
color selection, and add-to-cart functionality.
\`\`\`
```
### Design System Implementation
1. **Tailwind Configuration**:
\`\`\`
```
I need to set up a custom Tailwind configuration that implements
our design system tokens for colors, typography, spacing, etc.
\`\`\`
```
2. **Component Library Setup**:
\`\`\`
```
Let's create a component library structure using Storybook to
document and showcase our design system components.
\`\`\`
```
3. **Core Component Creation**:
\`\`\`
```
Let's implement the core components of our design system:
Button, Input, Card, and Modal.
\`\`\`
```
## Roocode-Specific Features
@ -85,29 +85,29 @@ testability, and integration with existing codebases.
Roocode offers visual editing capabilities. Use this to your advantage:
\`\`\`
```
Can you help me design the layout for our product card component
using Roocode's visual editor?
\`\`\`
```
### Real-time Preview
Leverage Roocode's real-time preview feature:
\`\`\`
```
Let's implement this component and see how it looks in the preview
as we make changes.
\`\`\`
```
### Component Library Integration
Use Roocode's component library integration:
\`\`\`
```
I want to integrate Material UI components into our project.
Please show me how to set this up and customize the components
to match our design system.
\`\`\`
```
## Tips for Best Results
@ -140,7 +140,7 @@ to match our design system.
Here's an example of a complete session with the v0 UX/UI Architect in Roocode:
\`\`\`
```
User: I want to work with the v0 UX/UI IDE Architect from the BMAD Method.
AI: I'll embody the v0 UX/UI IDE Architect persona. I'm Victor, specialized in direct implementation of frontend components with a focus on code quality, testability, and integration with existing codebases. How can I help with your frontend implementation today?
@ -173,7 +173,7 @@ User: Perfect! Can you also show me how to make this accessible?
AI: Let's make sure our navigation is fully accessible:
[Updates implementation with accessibility features]
\`\`\`
```
## Conclusion

View File

@ -1,4 +1,4 @@
# Training Guide: Using the v0 UX/UI Architect
# Training Guide: Using the v0 UX/UI Architect
This guide will help you effectively use the v0 UX/UI Architect persona in your projects, whether in web-based AI environments or directly in your IDE.
@ -52,44 +52,44 @@ The quality of your output depends significantly on your prompts. Here are guide
### Basic Structure
\`\`\`
```
I need [component/design/system] for [project type] with [specific requirements].
The brand values are [values]. The target audience is [audience].
[Additional context or constraints]
\`\`\`
```
### Example Prompts
#### For Design System Creation:
\`\`\`
```
I need a design system for a healthcare application focused on elderly users.
The brand values are trustworthy, accessible, and compassionate.
The application needs to be extremely accessible, with large touch targets
and high contrast. Please create the color system, typography, spacing,
and core components that would form this design system.
\`\`\`
```
#### For Component Creation:
\`\`\`
```
I need a patient information card component for our healthcare app.
It should display the patient's name, photo, key health metrics,
upcoming appointments, and medication schedule. It needs to be
scannable by busy healthcare providers and should include
appropriate actions like "View Details" and "Contact Patient."
Please create this component following our existing design system.
\`\`\`
```
#### For IDE Implementation:
\`\`\`
```
I need to implement a responsive navigation system for our React application.
It should include a desktop horizontal menu that collapses to a hamburger
menu on mobile. The navigation should include dropdown support for nested
items, highlight the current page, and be fully keyboard accessible.
Please implement this using our existing Tailwind setup.
\`\`\`
```
## Working with the v0 UX/UI Architect

View File

@ -1,4 +1,4 @@
# v0 UX/UI Architect User Guide
# v0 UX/UI Architect User Guide
## Overview
@ -39,7 +39,7 @@ The v0 UX/UI Architect is a specialized persona in the BMAD Method designed to b
- "I want to create some frontend components"
### Sample Prompts:
\`\`\`
```
"Veronica, I need you to create a modern dashboard component for a SaaS application.
It should include a sidebar navigation, main content area, and header with user profile."
@ -48,7 +48,7 @@ It needs to show product image, title, price, and add to cart button."
"I need a complete design system for a fintech application.
Can you create the core components with consistent styling?"
\`\`\`
```
### Expected Outputs:
- Detailed component specifications
@ -87,7 +87,7 @@ Can you create the core components with consistent styling?"
3. Begin rapid prototyping workflow
### Sample IDE Prompts:
\`\`\`
```
"Victor, I need you to implement a responsive navigation component using React and Tailwind CSS.
It should work on mobile and desktop with a hamburger menu for mobile."
@ -96,7 +96,7 @@ Use TypeScript and make it reusable across the application."
"I need a complete login form with validation, error handling, and accessibility features.
Implement it using our existing design system tokens."
\`\`\`
```
### Expected Outputs:
- Complete component files (JSX/TSX, CSS, tests)

View File

@ -1,4 +1,4 @@
\`\`\`mermaid
```mermaid
flowchart TD
%% Phase 0: BA
subgraph BA["Phase 0: Business Analyst"]
@ -80,4 +80,4 @@ flowchart TD
class BA_P,PM_PRD,ARCH_D artifact
class BA_B,BA_R,PM_D,PM_M,ARCH_P,SM_S,DEV_I,DEV_T,DEV_D process
class PM_C,ARCH_C,PO_C,PO_A,SM_A,DEV_A approval
\`\`\`
```

View File

@ -1,4 +1,4 @@
# v0 UX/UI Architect Example Project
# v0 UX/UI Architect Example Project
This example demonstrates how to use the v0 UX/UI Architect persona to create a complete component library for a fictional e-commerce application.
@ -11,15 +11,15 @@ This example demonstrates how to use the v0 UX/UI Architect persona to create a
## Step 1: Initial Prompt to v0 UX/UI Architect
\`\`\`
```
I need a component library for a modern e-commerce platform called ModernShop. The brand values are minimalist, premium, sustainable, and inclusive. The target audience is fashion-conscious consumers aged 25-45. Please create a design system and core components that reflect these values.
\`\`\`
```
## Step 2: Design System Definition
The v0 UX/UI Architect will first establish the design system foundations:
\`\`\`markdown
```markdown
# ModernShop Design System
## Color Palette
@ -54,7 +54,7 @@ The v0 UX/UI Architect will first establish the design system foundations:
- Subtle: 0 2px 4px rgba(0,0,0,0.05)
- Medium: 0 4px 8px rgba(0,0,0,0.1)
- Strong: 0 8px 16px rgba(0,0,0,0.15)
\`\`\`
```
## Step 3: Core Component Creation
@ -62,7 +62,7 @@ The v0 UX/UI Architect will then generate core components:
### Button Component
\`\`\`tsx
```tsx
// Button.tsx
import React from 'react';
import './Button.css';
@ -101,11 +101,11 @@ export const Button: React.FC<ButtonProps> = ({
</button>
);
};
\`\`\`
```
### Product Card Component
\`\`\`tsx
```tsx
// ProductCard.tsx
import React from 'react';
import './ProductCard.css';
@ -174,13 +174,13 @@ export const ProductCard: React.FC<ProductCardProps> = ({
</div>
);
};
\`\`\`
```
## Step 4: Component Documentation
The v0 UX/UI Architect will create comprehensive documentation for each component:
\`\`\`markdown
```markdown
# Button Component
## Overview
@ -204,7 +204,7 @@ The Button component is a versatile, accessible button that supports multiple va
- Focus states are clearly visible
## Usage Examples
\`\`\`tsx
```tsx
// Primary button
<Button label="Add to Cart" onClick={handleAddToCart} />
@ -230,21 +230,21 @@ The Button component is a versatile, accessible button that supports multiple va
fullWidth={true}
onClick={handleViewAll}
/>
\`\`\`
```
## Step 5: IDE Implementation
For IDE environments like Cursor AI, the v0 UX/UI IDE Architect would implement the components directly in the codebase:
\`\`\`
```
I need to implement the Button component from our ModernShop design system in our React codebase. The component should support primary, secondary, tertiary, and ghost variants, multiple sizes, and include proper accessibility features.
\`\`\`
```
## Step 6: Quality Assurance
The v0 UX/UI Architect will run the component through the quality checklist:
\`\`\`markdown
```markdown
# Button Component Quality Checklist
## Design Consistency
@ -277,7 +277,7 @@ The v0 UX/UI Architect will run the component through the quality checklist:
- [x] Dependencies clearly documented
- [x] Integration examples provided
- [x] Storybook story created
\`\`\`
```
## Conclusion

View File

@ -1,4 +1,4 @@
==================== START: advanced-elicitation ====================
==================== START: advanced-elicitation ====================
# Advanced Elicitation Task
## Purpose
@ -15,7 +15,7 @@
**Present the numbered list (0-9) with this exact format:**
\`\`\`
```
**Advanced Reflective, Elicitation & Brainstorming Actions**
Choose an action (0-9 - 9 to bypass - HELP for explanation of these options):
@ -29,7 +29,7 @@ Choose an action (0-9 - 9 to bypass - HELP for explanation of these options):
7. Explore Diverse Alternatives (ToT-Inspired)
8. Hindsight is 20/20: The 'If Only...' Reflection
9. Proceed / No Further Actions
\`\`\`
```
### 2. Processing Guidelines
@ -199,9 +199,9 @@ The BMAD Method uses various checklists to ensure quality and completeness of di
- Look for evidence in the documentation that satisfies the requirement
- Consider both explicit mentions and implicit coverage
- Mark items as:
- PASS: Requirement clearly met
- FAIL: Requirement not met or insufficient coverage
- ⚠️ PARTIAL: Some aspects covered but needs improvement
- ✅ PASS: Requirement clearly met
- ❌ FAIL: Requirement not met or insufficient coverage
- ⚠️ PARTIAL: Some aspects covered but needs improvement
- N/A: Not applicable to this case
5. **Section Analysis**
@ -1006,7 +1006,7 @@ To design a comprehensive infrastructure architecture that defines all aspects o
### 5. Implementation Feasibility Review & Collaboration
- **Architect DevOps/Platform Feedback Loop:**
- **Architect → DevOps/Platform Feedback Loop:**
- Present architectural blueprint summary to DevOps/Platform Engineering Agent for feasibility review
- Request specific feedback on:
- **Operational Complexity:** Are the proposed patterns implementable with current tooling and expertise?
@ -1126,7 +1126,7 @@ To identify the next logical story based on project progress and epic definition
- Verify its `Status` is 'Done' (or equivalent).
- If not 'Done', present an alert to the user:
\`\`\`plaintext
```plaintext
ALERT: Found incomplete story:
File: {lastEpicNum}.{lastStoryNum}.story.md
Status: [current status]
@ -1137,7 +1137,7 @@ To identify the next logical story based on project progress and epic definition
3. Accept risk & Override to create the next story in draft
Please choose an option (1/2/3):
\`\`\`
```
- Proceed only if user selects option 3 (Override) or if the last story was 'Done'.
- If proceeding: Check the Epic File for `{lastEpicNum}` for a story numbered `{lastStoryNum + 1}`. If it exists and its prerequisites (per Epic File) are met, this is the next story.
@ -1215,7 +1215,7 @@ To implement a comprehensive platform infrastructure stack based on the Infrastr
### 1. Confirm Interaction Mode
- Ask the user: "How would you like to proceed with platform infrastructure implementation? We can work:
A. **Incrementally (Default & Recommended):** We'll implement each platform layer step-by-step (Foundation → Container Platform → GitOps → Service Mesh → Developer Experience), validating integration at each stage. This ensures thorough testing and operational readiness.
A. **Incrementally (Default & Recommended):** We'll implement each platform layer step-by-step (Foundation → Container Platform → GitOps → Service Mesh → Developer Experience), validating integration at each stage. This ensures thorough testing and operational readiness.
B. **"YOLO" Mode:** I'll implement the complete platform stack in logical groups, with validation at major integration milestones. This is faster but requires comprehensive end-to-end testing."
- Request the user to select their preferred mode and proceed accordingly.
@ -1230,7 +1230,7 @@ To implement a comprehensive platform infrastructure stack based on the Infrastr
### 3. Joint Implementation Planning Session
- **Architect DevOps/Platform Collaborative Planning:**
- **Architect ↔ DevOps/Platform Collaborative Planning:**
- **Architecture Alignment Review:**
- Confirm understanding of architectural decisions and rationale with Architect Agent
- Validate interpretation of infrastructure architecture document
@ -1736,11 +1736,11 @@ You are now operating as a Documentation Indexer. Your goal is to ensure all doc
Each entry in `docs/index.md` should follow this format:
\`\`\`markdown
```markdown
### [Document Title](relative/path/to/file.md)
Brief description of the document's purpose and contents.
\`\`\`
```
### Rules of Operation
@ -1772,7 +1772,7 @@ For each file referenced in the index but not found in the filesystem:
1. Present the entry:
\`\`\`markdown
```markdown
Missing file detected:
Title: [Document Title]
Path: relative/path/to/file.md
@ -1785,7 +1785,7 @@ For each file referenced in the index but not found in the filesystem:
3. Keep entry (mark as temporarily unavailable)
Please choose an option (1/2/3):
\`\`\`
```
2. Wait for user confirmation before taking any action
3. Log the decision for the final report
@ -1871,7 +1871,7 @@ To conduct a thorough review of existing infrastructure to identify improvement
### 6. Architectural Escalation Assessment
- **DevOps/Platform Architect Escalation Review:**
- **DevOps/Platform → Architect Escalation Review:**
- Evaluate review findings for issues requiring architectural intervention:
- **Technical Debt Escalation:**
- Identify infrastructure technical debt that impacts system architecture
@ -2003,7 +2003,7 @@ To comprehensively validate platform infrastructure changes against security, re
### 3. Architecture Design Review Gate
- **DevOps/Platform Architect Design Review:**
- **DevOps/Platform → Architect Design Review:**
- Conduct systematic review of infrastructure architecture document for implementability
- Evaluate architectural decisions against operational constraints and capabilities:
- **Implementation Complexity:** Assess if proposed architecture can be implemented with available tools and expertise

View File

@ -1,4 +1,4 @@
==================== START: architecture-tmpl ====================
==================== START: architecture-tmpl ====================
# {Project Name} Architecture Document
## Introduction / Preamble
@ -46,47 +46,47 @@ If the project includes a significant user interface, a separate Frontend Archit
{Provide an ASCII or Mermaid diagram representing the project's folder structure. The following is a general example. If a `front-end-architecture-tmpl.txt` (or equivalent) is in use, it will contain the detailed structure for the frontend portion (e.g., within `src/frontend/` or a dedicated `frontend/` root directory). Shared code structure (e.g., in a `packages/` directory for a monorepo) should also be detailed here.}
\`\`\`plaintext
```plaintext
{project-root}/
├── .github/ # CI/CD workflows (e.g., GitHub Actions)
│ └── workflows/
│ └── main.yml
├── .vscode/ # VSCode settings (optional)
│ └── settings.json
├── build/ # Compiled output (if applicable, often git-ignored)
├── config/ # Static configuration files (if any)
├── docs/ # Project documentation (PRD, Arch, etc.)
│ ├── index.md
│ └── ... (other .md files)
├── infra/ # Infrastructure as Code (e.g., CDK, Terraform)
│ └── lib/
│ └── bin/
├── node_modules/ / venv / target/ # Project dependencies (git-ignored)
├── scripts/ # Utility scripts (build, deploy helpers, etc.)
├── src/ # Application source code
│ ├── backend/ # Backend-specific application code (if distinct frontend exists)
│ │ ├── core/ # Core business logic, domain models
│ │ ├── services/ # Business services, orchestrators
│ │ ├── adapters/ # Adapters to external systems (DB, APIs)
│ │ ├── controllers/ / routes/ # API endpoint handlers
│ │ └── main.ts / app.py # Backend application entry point
│ ├── frontend/ # Placeholder: See Frontend Architecture Doc for details if used
│ ├── shared/ / common/ # Code shared (e.g., types, utils, domain models if applicable)
│ │ └── types/
│ └── main.ts / index.ts / app.ts # Main application entry point (if not using backend/frontend split above)
├── stories/ # Generated story files for development (optional)
│ └── epic1/
├── test/ # Automated tests
│ ├── unit/ # Unit tests (mirroring src structure)
│ ├── integration/ # Integration tests
│ └── e2e/ # End-to-end tests
├── .env.example # Example environment variables
├── .gitignore # Git ignore rules
├── package.json / requirements.txt / pom.xml # Project manifest and dependencies
├── tsconfig.json / pyproject.toml # Language-specific configuration (if applicable)
├── Dockerfile # Docker build instructions (if applicable)
└── README.md # Project overview and setup instructions
\`\`\`
├── .github/ # CI/CD workflows (e.g., GitHub Actions)
│ └── workflows/
│ └── main.yml
├── .vscode/ # VSCode settings (optional)
│ └── settings.json
├── build/ # Compiled output (if applicable, often git-ignored)
├── config/ # Static configuration files (if any)
├── docs/ # Project documentation (PRD, Arch, etc.)
│ ├── index.md
│ └── ... (other .md files)
├── infra/ # Infrastructure as Code (e.g., CDK, Terraform)
│ └── lib/
│ └── bin/
├── node_modules/ / venv / target/ # Project dependencies (git-ignored)
├── scripts/ # Utility scripts (build, deploy helpers, etc.)
├── src/ # Application source code
│ ├── backend/ # Backend-specific application code (if distinct frontend exists)
│ │ ├── core/ # Core business logic, domain models
│ │ ├── services/ # Business services, orchestrators
│ │ ├── adapters/ # Adapters to external systems (DB, APIs)
│ │ ├── controllers/ / routes/ # API endpoint handlers
│ │ └── main.ts / app.py # Backend application entry point
│ ├── frontend/ # Placeholder: See Frontend Architecture Doc for details if used
│ ├── shared/ / common/ # Code shared (e.g., types, utils, domain models if applicable)
│ │ └── types/
│ └── main.ts / index.ts / app.ts # Main application entry point (if not using backend/frontend split above)
├── stories/ # Generated story files for development (optional)
│ └── epic1/
├── test/ # Automated tests
│ ├── unit/ # Unit tests (mirroring src structure)
│ ├── integration/ # Integration tests
│ └── e2e/ # End-to-end tests
├── .env.example # Example environment variables
├── .gitignore # Git ignore rules
├── package.json / requirements.txt / pom.xml # Project manifest and dependencies
├── tsconfig.json / pyproject.toml # Language-specific configuration (if applicable)
├── Dockerfile # Docker build instructions (if applicable)
└── README.md # Project overview and setup instructions
```
(Adjust the example tree based on the actual project type - e.g., Python would have requirements.txt, etc. The structure above illustrates a potential separation for projects with distinct frontends; for simpler projects or APIs, the `src/` structure might be flatter.)
@ -158,7 +158,7 @@ If the project includes a significant user interface, a separate Frontend Archit
- **Description:** {What does this entity represent?}
- **Schema / Interface Definition:**
\`\`\`typescript
```typescript
// Example using TypeScript Interface
export interface {EntityName} {
id: string; // {Description, e.g., Unique identifier}
@ -166,7 +166,7 @@ If the project includes a significant user interface, a separate Frontend Archit
optionalProperty?: number; // {Description}
// ... other properties
}
\`\`\`
```
- **Validation Rules:** {List any specific validation rules beyond basic types - e.g., max length, format, range.}
### API Payload Schemas (If distinct)
@ -176,14 +176,14 @@ If the project includes a significant user interface, a separate Frontend Archit
#### {API Endpoint / Purpose, e.g., Create Order Request, repeat the section as needed}
- **Schema / Interface Definition:**
\`\`\`typescript
```typescript
// Example
export interface CreateOrderRequest {
customerId: string;
items: { productId: string; quantity: number }[];
// ...
}
\`\`\`
```
### Database Schemas (If applicable)
@ -193,7 +193,7 @@ If the project includes a significant user interface, a separate Frontend Archit
- **Purpose:** {What data does this table store?}
- **Schema Definition:**
\`\`\`sql
```sql
-- Example SQL
CREATE TABLE {TableName} (
id VARCHAR(36) PRIMARY KEY,
@ -201,7 +201,7 @@ If the project includes a significant user interface, a separate Frontend Archit
numeric_column DECIMAL(10, 2),
-- ... other columns, indexes, constraints
);
\`\`\`
```
_(Alternatively, use ORM model definitions, NoSQL document structure, etc.)_
## Core Workflow / Sequence Diagrams
@ -538,7 +538,7 @@ CRITICAL: **Index Management:** After creating the files, update `docs/index.md`
- **Framework & Core Libraries:** {e.g., React 18.x with Next.js 13.x, Angular 16.x, Vue 3.x with Nuxt.js}. **These are derived from the 'Definitive Tech Stack Selections' in the main Architecture Document.** This section elaborates on *how* these choices are applied specifically to the frontend.
- **Component Architecture:** {e.g., Atomic Design principles, Presentational vs. Container components, use of specific component libraries like Material UI, Tailwind CSS for styling approach. Specify chosen approach and any key libraries.}
- **State Management Strategy:** {e.g., Redux Toolkit, Zustand, Vuex, NgRx. Briefly describe the overall approach global store, feature stores, context API usage. **Referenced from main Architecture Document and detailed further in "State Management In-Depth" section.**}
- **State Management Strategy:** {e.g., Redux Toolkit, Zustand, Vuex, NgRx. Briefly describe the overall approach – global store, feature stores, context API usage. **Referenced from main Architecture Document and detailed further in "State Management In-Depth" section.**}
- **Data Flow:** {e.g., Unidirectional data flow (Flux/Redux pattern), React Query/SWR for server state. Describe how data is fetched, cached, passed to components, and updated.}
- **Styling Approach:** **{Chosen Styling Solution, e.g., Tailwind CSS / CSS Modules / Styled Components}**. Configuration File(s): {e.g., `tailwind.config.js`, `postcss.config.js`}. Key conventions: {e.g., "Utility-first approach for Tailwind. Custom components defined in `src/styles/components.css`. Theme extensions in `tailwind.config.js` under `theme.extend`. For CSS Modules, files are co-located with components, e.g., `MyComponent.module.css`.}
- **Key Design Patterns Used:** {e.g., Provider pattern, Hooks, Higher-Order Components, Service patterns for API calls, Container/Presentational. These patterns are to be consistently applied. Deviations require justification and documentation.}
@ -549,46 +549,46 @@ CRITICAL: **Index Management:** After creating the files, update `docs/index.md`
### EXAMPLE - Not Prescriptive (for a React/Next.js app)
\`\`\`plaintext
```plaintext
src/
├── app/ # Next.js App Router: Pages/Layouts/Routes. MUST contain route segments, layouts, and page components.
│ ├── (features)/ # Feature-based routing groups. MUST group related routes for a specific feature.
│ │ └── dashboard/
│ │ ├── layout.tsx # Layout specific to the dashboard feature routes.
│ │ └── page.tsx # Entry page component for a dashboard route.
│ ├── api/ # API Routes (if using Next.js backend features). MUST contain backend handlers for client-side calls.
│ ├── globals.css # Global styles. MUST contain base styles, CSS variable definitions, Tailwind base/components/utilities.
│ └── layout.tsx # Root layout for the entire application.
├── components/ # Shared/Reusable UI Components.
│ ├── ui/ # Base UI elements (Button, Input, Card). MUST contain only generic, reusable, presentational UI elements, often mapped from a design system. MUST NOT contain business logic.
│ │ ├── Button.tsx
│ │ └── ...
│ ├── layout/ # Layout components (Header, Footer, Sidebar). MUST contain components structuring page layouts, not specific page content.
│ │ ├── Header.tsx
│ │ └── ...
│ └── (feature-specific)/ # Components specific to a feature but potentially reusable within it. This is an alternative to co-locating within features/ directory.
│ └── user-profile/
│ └── ProfileCard.tsx
├── features/ # Feature-specific logic, hooks, non-global state, services, and components solely used by that feature.
│ └── auth/
│ ├── components/ # Components used exclusively by the auth feature. MUST NOT be imported by other features.
│ ├── hooks/ # Custom React Hooks specific to the 'auth' feature. Hooks reusable across features belong in `src/hooks/`.
│ ├── services/ # Feature-specific API interactions or orchestrations for the 'auth' feature.
│ └── store.ts # Feature-specific state slice (e.g., Redux slice) if not part of a global store or if local state is complex.
├── hooks/ # Global/sharable custom React Hooks. MUST be generic and usable by multiple features/components.
│ └── useAuth.ts
├── lib/ / utils/ # Utility functions, helpers, constants. MUST contain pure functions and constants, no side effects or framework-specific code unless clearly named (e.g., `react-helpers.ts`).
│ └── utils.ts
├── services/ # Global API service clients or SDK configurations. MUST define base API client instances and core data fetching/mutation services.
│ └── apiClient.ts
├── store/ # Global state management setup (e.g., Redux store, Zustand store).
│ ├── index.ts # Main store configuration and export.
│ ├── rootReducer.ts # Root reducer if using Redux.
│ └── (slices)/ # Directory for global state slices (if not co-located in features).
├── styles/ # Global styles, theme configurations (if not using `globals.css` or similar, or for specific styling systems like SCSS partials).
└── types/ # Global TypeScript type definitions/interfaces. MUST contain types shared across multiple features/modules.
└── index.ts
\`\`\`
├── app/ # Next.js App Router: Pages/Layouts/Routes. MUST contain route segments, layouts, and page components.
│ ├── (features)/ # Feature-based routing groups. MUST group related routes for a specific feature.
│ │ └── dashboard/
│ │ ├── layout.tsx # Layout specific to the dashboard feature routes.
│ │ └── page.tsx # Entry page component for a dashboard route.
│ ├── api/ # API Routes (if using Next.js backend features). MUST contain backend handlers for client-side calls.
│ ├── globals.css # Global styles. MUST contain base styles, CSS variable definitions, Tailwind base/components/utilities.
│ └── layout.tsx # Root layout for the entire application.
├── components/ # Shared/Reusable UI Components.
│ ├── ui/ # Base UI elements (Button, Input, Card). MUST contain only generic, reusable, presentational UI elements, often mapped from a design system. MUST NOT contain business logic.
│ │ ├── Button.tsx
│ │ └── ...
│ ├── layout/ # Layout components (Header, Footer, Sidebar). MUST contain components structuring page layouts, not specific page content.
│ │ ├── Header.tsx
│ │ └── ...
│ └── (feature-specific)/ # Components specific to a feature but potentially reusable within it. This is an alternative to co-locating within features/ directory.
│ └── user-profile/
│ └── ProfileCard.tsx
├── features/ # Feature-specific logic, hooks, non-global state, services, and components solely used by that feature.
│ └── auth/
│ ├── components/ # Components used exclusively by the auth feature. MUST NOT be imported by other features.
│ ├── hooks/ # Custom React Hooks specific to the 'auth' feature. Hooks reusable across features belong in `src/hooks/`.
│ ├── services/ # Feature-specific API interactions or orchestrations for the 'auth' feature.
│ └── store.ts # Feature-specific state slice (e.g., Redux slice) if not part of a global store or if local state is complex.
├── hooks/ # Global/sharable custom React Hooks. MUST be generic and usable by multiple features/components.
│ └── useAuth.ts
├── lib/ / utils/ # Utility functions, helpers, constants. MUST contain pure functions and constants, no side effects or framework-specific code unless clearly named (e.g., `react-helpers.ts`).
│ └── utils.ts
├── services/ # Global API service clients or SDK configurations. MUST define base API client instances and core data fetching/mutation services.
│ └── apiClient.ts
├── store/ # Global state management setup (e.g., Redux store, Zustand store).
│ ├── index.ts # Main store configuration and export.
│ ├── rootReducer.ts # Root reducer if using Redux.
│ └── (slices)/ # Directory for global state slices (if not co-located in features).
├── styles/ # Global styles, theme configurations (if not using `globals.css` or similar, or for specific styling systems like SCSS partials).
└── types/ # Global TypeScript type definitions/interfaces. MUST contain types shared across multiple features/modules.
└── index.ts
```
### Notes on Frontend Structure:
@ -629,14 +629,14 @@ src/
| `{anotherState}`| `{type}` | `{value}` | {Description of state variable and its purpose.} |
- **Key UI Elements / Structure:**
{ Provide a pseudo-HTML or JSX-like structure representing the component\'s DOM. Include key conditional rendering logic if applicable. **This structure dictates the primary output for the AI agent.** }
\`\`\`html
```html
<div> <!-- Main card container with specific class e.g., styles.cardFull or styles.cardCompact based on variant prop -->
<img src="{avatarUrl || defaultAvatar}" alt="User Avatar" class="{styles.avatar}" />
<h2>{userName}</h2>
<p class="{variant === 'full' ? styles.emailFull : styles.emailCompact}">{userEmail}</p>
{variant === 'full' && onEdit && <button onClick={onEdit} class="{styles.editButton}">Edit</button>}
</div>
\`\`\`
```
- **Events Handled / Emitted:**
- **Handles:** {e.g., `onClick` on the edit button (triggers `onEdit` prop).}
- **Emits:** {If the component emits custom events/callbacks not covered by props, describe them with their exact signature. e.g., `onFollow: (payload: { userId: string; followed: boolean }) => void`}
@ -671,7 +671,7 @@ _Repeat the above template for each significant component._
- **Core Slice Example (e.g., `sessionSlice` in `src/store/slices/sessionSlice.ts`):**
- **Purpose:** {Manages user session, authentication status, and basic user profile info accessible globally.}
- **State Shape (Interface/Type):**
\`\`\`typescript
```typescript
interface SessionState {
currentUser: { id: string; name: string; email: string; roles: string[]; } | null;
isAuthenticated: boolean;
@ -679,7 +679,7 @@ _Repeat the above template for each significant component._
status: "idle" | "loading" | "succeeded" | "failed";
error: string | null;
}
\`\`\`
```
- **Key Reducers/Actions (within `createSlice`):** {Briefly list main synchronous actions, e.g., `setCurrentUser`, `clearSession`, `setAuthStatus`, `setAuthError`.}
- **Async Thunks (if any):** {List key async thunks, e.g., `loginUserThunk`, `fetchUserProfileThunk`.}
- **Selectors (memoized with `createSelector`):** {List key selectors, e.g., `selectCurrentUser`, `selectIsAuthenticated`.}
@ -937,14 +937,14 @@ _Repeat the above template for each significant component._
## Information Architecture (IA)
- **Site Map / Screen Inventory:**
\`\`\`mermaid
```mermaid
graph TD
A[Homepage] --> B(Dashboard);
A --> C{Settings};
B --> D[View Details];
C --> E[Profile Settings];
C --> F[Notification Settings];
\`\`\`
```
_(Or provide a list of all screens/pages)_
- **Navigation Structure:** {Describe primary navigation (e.g., top bar, sidebar), secondary navigation, breadcrumbs, etc.}
@ -956,7 +956,7 @@ _Repeat the above template for each significant component._
- **Goal:** {What the user wants to achieve.}
- **Steps / Diagram:**
\`\`\`mermaid
```mermaid
graph TD
Start --> EnterCredentials[Enter Email/Password];
EnterCredentials --> ClickLogin[Click Login Button];
@ -964,7 +964,7 @@ _Repeat the above template for each significant component._
CheckAuth -- Yes --> Dashboard;
CheckAuth -- No --> ShowError[Show Error Message];
ShowError --> EnterCredentials;
\`\`\`
```
_(Or: Link to specific flow diagram in Figma/Miro)_
### {Another User Flow Name}