Skip to content

Commit 1f2ed64

Browse files
committed
Update documentation structure to reflect new directory organization for AI agent personas, moving all related files to docs/source/500/. Revise prompts and references in the workflow examples to ensure consistency with the new file paths. Add new sample documents for PRD, technical design, security assessment, sprint backlog, and implementation tasks for a task management mobile app project.
1 parent 0f19b50 commit 1f2ed64

File tree

9 files changed

+175
-35
lines changed

9 files changed

+175
-35
lines changed

.cursor/rules/product-owner.mdc

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -92,12 +92,12 @@ When creating PRDs, use this structure:
9292

9393
## Example Prompts That Work Well
9494

95-
- "Create a PRD for [feature/product]"
96-
- "Write user stories for [functionality]"
97-
- "Analyze the competitive landscape for [product category]"
98-
- "Define success metrics for [feature]"
99-
- "Create a product roadmap for [timeframe]"
100-
- "Prioritize these features using RICE framework"
95+
- "Create a PRD for [feature/product] and save to docs/source/500/[feature-name]-prd.md"
96+
- "Write user stories for [functionality] and save to docs/source/500/[feature-name]-stories.md"
97+
- "Analyze the competitive landscape for [product category] and save to docs/source/500/[feature-name]-competitive-analysis.md"
98+
- "Define success metrics for [feature] and save to docs/source/500/[feature-name]-metrics.md"
99+
- "Create a product roadmap for [timeframe] and save to docs/source/500/[feature-name]-roadmap.md"
100+
- "Prioritize these features using RICE framework and save to docs/source/500/[feature-name]-prioritization.md"
101101

102102
## Always Remember
103103

PERSONA-WORKFLOW-EXAMPLE.md

Lines changed: 34 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -26,17 +26,18 @@ In Cursor chat, use this prompt:
2626
- Password reset functionality
2727
- User profile management
2828
29-
Please save this PRD to a file called "user-auth-prd.md" in the docs/ directory.
29+
Please save this PRD to a file called "user-auth-prd.md" in the docs/source/500/ directory.
3030
```
3131

3232
**What happens:**
3333
- The Product Owner persona will create a comprehensive PRD
34-
- The AI will automatically save it to `docs/user-auth-prd.md`
34+
- The AI will automatically save it to `docs/source/500/user-auth-prd.md`
35+
- The file will be integrated into your ReadTheDocs documentation system
3536
- The file will be version-controlled in your repository
3637

3738
### Step 2: Review and Approve the PRD
3839

39-
1. Open the generated `docs/user-auth-prd.md` file
40+
1. Open the generated `docs/source/500/user-auth-prd.md` file
4041
2. Review the content for completeness and accuracy
4142
3. Make any necessary edits or request revisions
4243
4. Once satisfied, proceed to the next step
@@ -46,33 +47,33 @@ Please save this PRD to a file called "user-auth-prd.md" in the docs/ directory.
4647
After approving the PRD, use this prompt:
4748

4849
```
49-
@business-analyst Please review the PRD in docs/user-auth-prd.md and create a detailed technical design document that includes:
50+
@business-analyst Please review the PRD in docs/source/500/user-auth-prd.md and create a detailed technical design document that includes:
5051
- System architecture diagrams
5152
- Database schema design
5253
- API specifications
5354
- User flow diagrams
5455
- Integration requirements
5556
- Test scenarios
5657
57-
Please save this as "user-auth-design.md" in the docs/ directory and reference the original PRD.
58+
Please save this as "user-auth-design.md" in the docs/source/500/ directory and reference the original PRD.
5859
```
5960

6061
**What happens:**
6162
- The Business Analyst persona will read the existing PRD file
6263
- Create a comprehensive technical design document
63-
- Save it to `docs/user-auth-design.md`
64+
- Save it to `docs/source/500/user-auth-design.md`
6465
- Include references to the original PRD
6566

6667
### Step 4: Continue the Workflow
6768

6869
You can then continue with other personas:
6970

7071
```
71-
@software-engineer Review the design in docs/user-auth-design.md and create implementation tasks with technical specifications.
72+
@software-engineer Review the design in docs/source/500/user-auth-design.md and create implementation tasks with technical specifications. Save to docs/source/500/user-auth-tasks.md
7273
```
7374

7475
```
75-
@security-analyst Review both the PRD and design documents and provide a security assessment with recommendations.
76+
@security-analyst Review both the PRD and design documents and provide a security assessment with recommendations. Save to docs/source/500/user-auth-security.md
7677
```
7778

7879
## File Organization
@@ -81,22 +82,27 @@ Your project structure will look like this:
8182

8283
```
8384
project/
84-
├── docs/
85-
│ ├── user-auth-prd.md # Product Owner deliverable
86-
│ ├── user-auth-design.md # Business Analyst deliverable
87-
│ ├── user-auth-security.md # Security Analyst deliverable
88-
│ ├── user-auth-tasks.md # Software Engineer deliverable
85+
├── docs/source/500/
86+
│ ├── index.md # Personas section index
87+
│ ├── user-auth-prd.md # Product Owner deliverable
88+
│ ├── user-auth-design.md # Business Analyst deliverable
89+
│ ├── user-auth-security.md # Security Analyst deliverable
90+
│ ├── user-auth-tasks.md # Software Engineer deliverable
8991
│ └── user-auth-sprint-backlog.md # Scrum Master deliverable
90-
├── .cursor/
91-
│ └── rules/
92-
│ ├── product-owner.mdc
93-
│ ├── business-analyst.mdc
94-
│ ├── scrum-master.mdc
95-
│ ├── software-engineer.mdc
96-
│ └── security-analyst.mdc
97-
└── PERSONAS.md
92+
├── docs/source/
93+
│ └── index.rst # Main documentation index (includes 500/index)
94+
├── .cursor/rules/
95+
│ ├── product-owner.mdc
96+
│ ├── business-analyst.mdc
97+
│ ├── scrum-master.mdc
98+
│ ├── software-engineer.mdc
99+
│ └── security-analyst.mdc
100+
├── PERSONAS.md
101+
└── PERSONA-WORKFLOW-EXAMPLE.md
98102
```
99103

104+
**ReadTheDocs Integration**: All documents in `docs/source/500/` are automatically included in your ReadTheDocs documentation build and published online.
105+
100106
## Key Benefits
101107

102108
1. **Traceability**: Each document references previous ones
@@ -115,39 +121,39 @@ project/
115121

116122
### Example Iteration:
117123
```
118-
@product-owner The PRD in docs/user-auth-prd.md needs more detail on the social login providers. Please update it to include specific OAuth flows and error handling requirements.
124+
@product-owner The PRD in docs/source/500/user-auth-prd.md needs more detail on the social login providers. Please update it to include specific OAuth flows and error handling requirements.
119125
```
120126

121127
### Cross-Persona Collaboration:
122128
```
123-
@business-analyst Review the PRD in docs/user-auth-prd.md and the security recommendations in docs/user-auth-security.md, then update the design document to incorporate the security requirements.
129+
@business-analyst Review the PRD in docs/source/500/user-auth-prd.md and the security recommendations in docs/source/500/user-auth-security.md, then update the design document to incorporate the security requirements.
124130
```
125131

126132
## Sample Prompts for Each Stage
127133

128134
### Initial PRD Creation:
129135
```
130-
@product-owner Create a PRD for [feature description]. Include market research, user stories, success metrics, and technical considerations. Save to docs/[feature-name]-prd.md
136+
@product-owner Create a PRD for [feature description]. Include market research, user stories, success metrics, and technical considerations. Save to docs/source/500/[feature-name]-prd.md
131137
```
132138

133139
### Design from PRD:
134140
```
135-
@business-analyst Based on the PRD in docs/[feature-name]-prd.md, create a technical design document with architecture, database design, and API specs. Save to docs/[feature-name]-design.md
141+
@business-analyst Based on the PRD in docs/source/500/[feature-name]-prd.md, create a technical design document with architecture, database design, and API specs. Save to docs/source/500/[feature-name]-design.md
136142
```
137143

138144
### Implementation Planning:
139145
```
140-
@software-engineer Review docs/[feature-name]-design.md and break it down into development tasks with technical specifications. Save to docs/[feature-name]-tasks.md
146+
@software-engineer Review docs/source/500/[feature-name]-design.md and break it down into development tasks with technical specifications. Save to docs/source/500/[feature-name]-tasks.md
141147
```
142148

143149
### Security Review:
144150
```
145-
@security-analyst Conduct a security assessment of the feature described in docs/[feature-name]-prd.md and docs/[feature-name]-design.md. Save recommendations to docs/[feature-name]-security.md
151+
@security-analyst Conduct a security assessment of the feature described in docs/source/500/[feature-name]-prd.md and docs/source/500/[feature-name]-design.md. Save recommendations to docs/source/500/[feature-name]-security.md
146152
```
147153

148154
### Sprint Planning:
149155
```
150-
@scrum-master Based on the tasks in docs/[feature-name]-tasks.md, create a sprint plan with story points, dependencies, and timeline. Save to docs/[feature-name]-sprint-plan.md
156+
@scrum-master Based on the tasks in docs/source/500/[feature-name]-tasks.md, create a sprint plan with story points, dependencies, and timeline. Save to docs/source/500/[feature-name]-sprint-backlog.md
151157
```
152158

153159
This workflow ensures that each persona builds upon the previous work, creating a comprehensive and traceable development process.

docs/source/500/index.md

Lines changed: 133 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,133 @@
1+
# 500 - AI Agent Personas
2+
3+
This section contains documentation generated by AI agent personas - specialized AI agents designed for specific work tasks and roles. Each persona creates professional-quality deliverables following industry best practices.
4+
5+
## What are AI Agent Personas?
6+
7+
AI Agent Personas are documented specifications that define:
8+
- **Role & Responsibilities**: What the AI agent is designed to do
9+
- **Capabilities**: Specific skills and knowledge areas
10+
- **Output Formats**: Expected deliverables and document types
11+
- **Communication Style**: How the agent should interact
12+
- **Domain Expertise**: Specialized knowledge and best practices
13+
14+
## Available Personas
15+
16+
### Product Owner (`@product-owner`)
17+
- **Purpose**: Creates Product Requirement Documents (PRDs) and manages product strategy
18+
- **Key Deliverables**: PRDs, User Stories, Product Roadmaps, Feature Specifications
19+
- **Best For**: Product planning, feature definition, stakeholder communication
20+
21+
### Business Analyst (`@business-analyst`)
22+
- **Purpose**: Analyzes requirements and creates technical specifications
23+
- **Key Deliverables**: BRDs, Functional Specifications, Process Flow Diagrams, Use Cases
24+
- **Best For**: Requirements gathering, process analysis, gap analysis
25+
26+
### Scrum Master (`@scrum-master`)
27+
- **Purpose**: Facilitates agile processes and removes impediments
28+
- **Key Deliverables**: Sprint Planning Agendas, Retrospective Action Items, Team Velocity Reports
29+
- **Best For**: Agile facilitation, team coaching, process optimization
30+
31+
### Software Engineer (`@software-engineer`)
32+
- **Purpose**: Designs, develops, and maintains software systems
33+
- **Key Deliverables**: Technical Design Documents, Code Implementation, API Documentation
34+
- **Best For**: Software development, system architecture, code reviews
35+
36+
### Security Analyst (`@security-analyst`)
37+
- **Purpose**: Conducts security assessments and implements security measures
38+
- **Key Deliverables**: Security Assessment Reports, Threat Modeling Reports, Incident Response Plans
39+
- **Best For**: Security assessments, vulnerability analysis, compliance management
40+
41+
## Example Workflow: Task Management Mobile App
42+
43+
This section demonstrates a complete workflow using AI agent personas, from initial product requirements to sprint-ready development tasks.
44+
45+
### 100 - Product Requirements Document
46+
See [Product Requirements Document](sample-mobile-app-prd.md) - Created by Product Owner persona
47+
48+
**Overview**: Comprehensive PRD for a Task Management Mobile App including market analysis, user stories, success metrics, and go-to-market strategy.
49+
50+
**Key Features**:
51+
- Mobile-first task management
52+
- Real-time team collaboration
53+
- Offline functionality
54+
- Freemium business model
55+
56+
### 200 - Technical Design Document
57+
See [Technical Design Document](sample-mobile-app-design.md) - Created by Business Analyst persona
58+
59+
**Overview**: Detailed system architecture, database design, and API specifications based on the PRD.
60+
61+
**Key Components**:
62+
- React Native + Node.js + PostgreSQL stack
63+
- Microservices architecture
64+
- Real-time synchronization with WebSockets
65+
- Comprehensive API specifications
66+
67+
### 300 - Security Assessment Report
68+
See [Security Assessment Report](sample-mobile-app-security.md) - Created by Security Analyst persona
69+
70+
**Overview**: Comprehensive security evaluation covering threat modeling, risk assessment, and compliance requirements.
71+
72+
**Key Areas**:
73+
- GDPR/CCPA compliance analysis
74+
- OWASP Mobile Top 10 assessment
75+
- End-to-end encryption recommendations
76+
- Incident response planning
77+
78+
### 400 - Technical Implementation Tasks
79+
See [Technical Implementation Tasks](sample-mobile-app-tasks.md) - Created by Software Engineer persona
80+
81+
**Overview**: Detailed breakdown of 24 technical tasks across 4 development phases with effort estimates and acceptance criteria.
82+
83+
**Key Elements**:
84+
- 16-week development timeline
85+
- Detailed task dependencies
86+
- Security requirements integration
87+
- Performance optimization plans
88+
89+
### 500 - Sprint Backlog
90+
See [Sprint Backlog](sample-mobile-app-sprint-backlog.md) - Created by Scrum Master persona
91+
92+
**Overview**: Agile sprint planning with 20 user stories organized into 4 sprints, including story point estimation and capacity planning.
93+
94+
**Key Features**:
95+
- 4-week sprint cycles
96+
- Story point estimation
97+
- Risk mitigation strategies
98+
- Sprint ceremonies and definitions
99+
100+
## How to Use Personas
101+
102+
### Activation
103+
In Cursor chat, use `@persona-name` to activate any persona:
104+
105+
```
106+
@product-owner Create a PRD for [feature description]
107+
@business-analyst Create technical design based on PRD
108+
@security-analyst Conduct security assessment
109+
@software-engineer Create implementation tasks
110+
@scrum-master Create sprint backlog from tasks
111+
```
112+
113+
### Workflow Process
114+
1. **Product Owner** creates initial PRD
115+
2. **Business Analyst** creates technical design
116+
3. **Security Analyst** creates security assessment
117+
4. **Software Engineer** creates implementation tasks
118+
5. **Scrum Master** creates sprint backlog
119+
6. **Development Team** executes sprints
120+
121+
### File Organization
122+
Documents are automatically saved to `docs/source/500/` directory and integrated into the documentation system for ReadTheDocs publishing.
123+
124+
## Benefits
125+
126+
- **Professional Quality**: Industry-standard deliverables
127+
- **Complete Traceability**: Each document builds on previous work
128+
- **Version Control**: All documents stored in repository
129+
- **Team Collaboration**: Multiple stakeholders can review and contribute
130+
- **Automated Publishing**: Integrated with ReadTheDocs workflow
131+
- **Agile Integration**: Sprint-ready development artifacts
132+
133+
For detailed usage instructions, see the main [PERSONAS.md](../../../PERSONAS.md) documentation.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.

docs/source/index.rst

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,9 +9,10 @@ Welcome to Your Project Documentation
99
200/index
1010
300/index
1111
400/index
12+
500/index
1213

1314
Indices and tables
1415
==================
1516

1617
* :ref:`genindex`
17-
* :ref:`search`
18+
* :ref:`search`

0 commit comments

Comments
 (0)