style: apply prettier and yaml formatting

Auto-formatting applied by prettier and yaml-format tools.

🤖 Generated with [Claude Code](https://claude.ai/code)

Co-Authored-By: Claude <noreply@anthropic.com>
This commit is contained in:
Brian Madison
2025-06-15 14:20:19 -05:00
parent b53d954b7a
commit c5fe28e76b
18 changed files with 168 additions and 108 deletions

View File

@@ -2,27 +2,24 @@
CRITICAL: Read the full YML, start activation to alter your state of being, follow startup section instructions, stay in this being until told to exit this mode:
```yml
```yaml
activation-instructions:
- Follow all instructions in this file -> this defines you, your persona and more importantly what you can do. STAY IN CHARACTER!
- Only read the files/tasks listed here when user selects them for execution to minimize context usage
- The customization field ALWAYS takes precedence over any conflicting instructions
- When listing tasks/templates or presenting options during conversations, always show as numbered options list, allowing the user to type a number to select or execute
- Follow all instructions in this file -> this defines you, your persona and more importantly what you can do. STAY IN CHARACTER!
- Only read the files/tasks listed here when user selects them for execution to minimize context usage
- The customization field ALWAYS takes precedence over any conflicting instructions
- When listing tasks/templates or presenting options during conversations, always show as numbered options list, allowing the user to type a number to select or execute
agent:
name: Mary
id: analyst
title: Business Analyst
icon: 📊
whenToUse: "Use for market research, brainstorming, competitive analysis, creating project briefs, and initial project discovery"
customization:
whenToUse: Use for market research, brainstorming, competitive analysis, creating project briefs, and initial project discovery
customization: null
persona:
role: Insightful Analyst & Strategic Ideation Partner
style: Analytical, inquisitive, creative, facilitative, objective, data-informed
identity: Strategic analyst specializing in brainstorming, market research, competitive analysis, and project briefing
focus: Research planning, ideation facilitation, strategic analysis, actionable insights
core_principles:
- Curiosity-Driven Inquiry - Ask probing "why" questions to uncover underlying truths
- Objective & Evidence-Based Analysis - Ground findings in verifiable data and credible sources
@@ -35,19 +32,16 @@ persona:
- Maintaining a Broad Perspective - Stay aware of market trends and dynamics
- Integrity of Information - Ensure accurate sourcing and representation
- Numbered Options Protocol - Always use numbered lists for selections
startup:
- Greet the user with your name and role, and inform of the *help command.
commands:
- "*help" - Show: numbered list of the following commands to allow selection
- "*chat-mode" - (Default) Strategic analysis consultation with advanced-elicitation
- "*create-doc {template}" - Create doc (no template = show available templates)
- "*brainstorm {topic}" - Facilitate structured brainstorming session
- "*research {topic}" - Generate deep research prompt for investigation
- "*elicit" - Run advanced elicitation to clarify requirements
- "*exit" - Say goodbye as the Business Analyst, and then abandon inhabiting this persona
- '*help" - Show: numbered list of the following commands to allow selection'
- '*chat-mode" - (Default) Strategic analysis consultation with advanced-elicitation'
- '*create-doc {template}" - Create doc (no template = show available templates)'
- '*brainstorm {topic}" - Facilitate structured brainstorming session'
- '*research {topic}" - Generate deep research prompt for investigation'
- '*elicit" - Run advanced elicitation to clarify requirements'
- '*exit" - Say goodbye as the Business Analyst, and then abandon inhabiting this persona'
dependencies:
tasks:
- brainstorming-techniques

View File

@@ -2,7 +2,7 @@
CRITICAL: Read the full YML, start activation to alter your state of being, follow startup section instructions, stay in this being until told to exit this mode:
```yml
```yaml
activation-instructions:
- Follow all instructions in this file -> this defines you, your persona and more importantly what you can do. STAY IN CHARACTER!
- Only read the files/tasks listed here when user selects them for execution to minimize context usage

View File

@@ -14,11 +14,13 @@ Simple document migration that cleans up heading formats and adds epic structure
## Migration Rules
### For PRDs
- Find all level 3 headings that appear to be epics
- Add a level 2 heading "## Epic #" (incrementing number) before each epic
- Also apply the heading cleanup rules below
### For All Documents
- Find all level 2 headings (`## ...`)
- Remove leading numbers and symbols
- Keep only alphabetic characters and spaces
@@ -29,6 +31,7 @@ Simple document migration that cleans up heading formats and adds epic structure
- `## 3) User Experience``## User Experience`
### For Architecture Documents
- **PRIMARY GOAL**: Align level 2 headings to match template level 2 titles exactly
- **PRESERVE EVERYTHING**: Do not lose any information during migration
- Map existing content to the closest matching template section
@@ -37,6 +40,7 @@ Simple document migration that cleans up heading formats and adds epic structure
## Detection Logic
A document is considered a PRD if:
- Filename contains "prd" (case insensitive)
- OR main title contains "Product Requirements" or "PRD"
- OR contains sections like "User Stories", "Functional Requirements", "Acceptance Criteria"
@@ -45,7 +49,7 @@ A document is considered a PRD if:
1. **Backup Original**: Copy `filename.md` to `filename.md.bak`
2. **Detect Type**: Check if document is a PRD
3. **Process Headings**:
3. **Process Headings**:
- Clean all level 2 headings
- If PRD: Add epic structure before level 3 headings that look like epics
4. **Write Result**: Overwrite original file with migrated content
@@ -53,6 +57,7 @@ A document is considered a PRD if:
## Epic Detection for PRDs
Level 3 headings are treated as epics if they:
- Describe features or functionality
- Are substantial sections (not just "Overview" or "Notes")
- Common epic patterns: "User Management", "Payment Processing", "Reporting Dashboard"
@@ -62,24 +67,31 @@ The epic numbering starts at 1 and increments for each epic found.
## Example
### Before (PRD):
```markdown
````markdown
# Product Requirements Document
## 1. Executive Summary
Content here...
## 2.1 Functional Requirements & Specs
Content here...
### User Management System
Epic content...
### Payment Processing
Epic content...
## 3) Success Metrics
Content here...
```text
````text
### After (PRD):
```markdown
@@ -123,4 +135,5 @@ Content...
## Technical Stack Tools
Content...
```
````
````

View File

@@ -56,7 +56,7 @@ You are now operating as a Documentation Indexer. Your goal is to ensure all doc
The index should be organized as follows:
```markdown
````markdown
# Documentation Index
## Root Documents
@@ -88,7 +88,8 @@ Documents within the `another-folder/` directory:
### [Nested Document](./another-folder/document.md)
Description of nested document.
```text
````text
### Index Entry Format
@@ -98,7 +99,8 @@ Each entry should follow this format:
### [Document Title](relative/path/to/file.md)
Brief description of the document's purpose and contents.
```
````
````
### Rules of Operation

View File

@@ -109,7 +109,7 @@ Document the choice and key services that will be used.]]
Use appropriate diagram type for clarity.]]
```mermaid
````mermaid
{{architecture_diagram}}
```text
@@ -222,7 +222,7 @@ After presenting all data models, apply `tasks#advanced-elicitation` protocol]]
model_interface;
}
}
```
````
**Relationships:**
@@ -246,7 +246,7 @@ After presenting all data models, apply `tasks#advanced-elicitation` protocol]]
**TypeScript Interface:**
```typescript
````typescript
interface User {
id: string;
email: string;
@@ -300,13 +300,13 @@ servers:
'[object Object]': null
description:
'[object Object]': null
```
````
^^/CONDITION: has_rest_api^^
^^CONDITION: has_graphql_api^^
```graphql
````graphql
# GraphQL Schema
{{graphql_schema}}
```text
@@ -322,7 +322,7 @@ servers:
trpc_routers;
}
}
```
````
^^/CONDITION: has_trpc_api^^
@@ -469,11 +469,11 @@ After presenting this section, apply `tasks#advanced-elicitation` protocol]]
```text
{{component_structure}}
```
```text
**Component Template:**
```typescript
````typescript
{
{
component_template;
@@ -493,7 +493,7 @@ After presenting this section, apply `tasks#advanced-elicitation` protocol]]
state_structure;
}
}
```
````
**State Management Patterns:**
@@ -512,7 +512,7 @@ After presenting this section, apply `tasks#advanced-elicitation` protocol]]
**Protected Route Pattern:**
```typescript
````typescript
{
{
protected_route_example;
@@ -532,11 +532,11 @@ After presenting this section, apply `tasks#advanced-elicitation` protocol]]
api_client_setup;
}
}
```
````
**Service Example:**
```typescript
````typescript
{
{
service_example;
@@ -557,9 +557,11 @@ After presenting this section, apply `tasks#advanced-elicitation` protocol]]
^^CONDITION: serverless^^
**Function Organization:**
```
````
{{function_structure}}
```text
````text
**Function Template:**
@@ -569,7 +571,7 @@ After presenting this section, apply `tasks#advanced-elicitation` protocol]]
function_template;
}
}
```
````
^^/CONDITION: serverless^^
@@ -578,11 +580,11 @@ After presenting this section, apply `tasks#advanced-elicitation` protocol]]
```text
{{controller_structure}}
```
```text
**Controller Template:**
```typescript
````typescript
{
{
controller_template;
@@ -600,11 +602,11 @@ After presenting this section, apply `tasks#advanced-elicitation` protocol]]
```sql
{{database_schema}}
```
````
**Data Access Layer:**
```typescript
````typescript
{
{
repository_pattern;
@@ -620,11 +622,11 @@ After presenting this section, apply `tasks#advanced-elicitation` protocol]]
```mermaid
{{auth_flow_diagram}}
```
````
**Middleware/Guards:**
```typescript
````typescript
{
{
auth_middleware;
@@ -690,7 +692,7 @@ After presenting this section, apply `tasks#advanced-elicitation` protocol]]
├── package.json # Root package.json
├── {{monorepo_config}} # Monorepo configuration
└── README.md
```
````
@{example: vercel_structure}
apps/
@@ -712,7 +714,7 @@ After presenting this section, apply `tasks#advanced-elicitation` protocol]]
**Prerequisites:**
```bash
````bash
{{prerequisites_commands}}
```text
@@ -720,11 +722,11 @@ After presenting this section, apply `tasks#advanced-elicitation` protocol]]
```bash
{{setup_commands}}
```
````
**Development Commands:**
```bash
````bash
# Start all services
{{start_all_command}}
@@ -751,7 +753,7 @@ After presenting this section, apply `tasks#advanced-elicitation` protocol]]
# Shared
{{shared_env_vars}}
```
````
## Deployment Architecture
@@ -774,7 +776,7 @@ After presenting this section, apply `tasks#advanced-elicitation` protocol]]
### CI/CD Pipeline
```yml
````yaml
'[object Object]': null
```text
@@ -834,12 +836,15 @@ After presenting this section, apply `tasks#advanced-elicitation` protocol]]
### Testing Pyramid
```
````
E2E Tests
/ \
Integration Tests
/ \
Frontend Unit Backend Unit
/ \
Frontend Unit Backend Unit
```text
### Test Organization
@@ -847,20 +852,26 @@ After presenting this section, apply `tasks#advanced-elicitation` protocol]]
**Frontend Tests:**
```
{{frontend_test_structure}}
```text
**Backend Tests:**
```
```text
{{backend_test_structure}}
```text
**E2E Tests:**
```
{{e2e_test_structure}}
```text
````text
### Test Examples
@@ -872,11 +883,11 @@ After presenting this section, apply `tasks#advanced-elicitation` protocol]]
frontend_test_example;
}
}
```
````
**Backend API Test:**
```typescript
````typescript
{
{
backend_test_example;
@@ -892,7 +903,7 @@ After presenting this section, apply `tasks#advanced-elicitation` protocol]]
e2e_test_example;
}
}
```
````
## Coding Standards
@@ -933,7 +944,7 @@ After presenting this section, apply `tasks#advanced-elicitation` protocol]]
### Error Flow
```mermaid
````mermaid
{{error_flow_diagram}}
```text
@@ -949,11 +960,11 @@ interface ApiError {
requestId: string;
};
}
```
````
### Frontend Error Handling
```typescript
````typescript
{
{
frontend_error_handler;
@@ -969,7 +980,7 @@ interface ApiError {
backend_error_handler;
}
}
```
````
## Monitoring and Observability

View File

@@ -137,7 +137,7 @@ After presenting all data models, apply `tasks#advanced-elicitation` protocol]]
**TypeScript Interface:**
```typescript
````typescript
{
{
model_interface;
@@ -183,7 +183,7 @@ interface UserProfile {
bio?: string;
preferences: Record<string, any>;
}
```
````
**Relationships:**
@@ -207,7 +207,7 @@ Use appropriate format for the chosen API style. If no API (e.g., static site),
^^CONDITION: has_rest_api^^
```yml
````yml
openapi: 3.0.0
info:
title:
@@ -230,7 +230,7 @@ servers:
```graphql
# GraphQL Schema
{{graphql_schema}}
```
````
^^/CONDITION: has_graphql_api^^