189 lines
7.7 KiB
Plaintext
189 lines
7.7 KiB
Plaintext
# {Project Name} Product Requirements Document (PRD)
|
|
|
|
## Goal, Objective and Context
|
|
|
|
Keep this brief and to the point in the final output - this should come mostly from the user or the provided brief, but ask for clarifications as needed.
|
|
|
|
## Functional Requirements (MVP)
|
|
|
|
You should have a good idea at this point, but clarify suggest question and explain to ensure these are correct.
|
|
|
|
## Non Functional Requirements (MVP)
|
|
|
|
## User Interaction and Design Goals
|
|
|
|
If there is a UX/UI Component, we want to work with the user to elicit enough information to detail the UI look and feel, screens, interaction, functionality so that we can produce the UI as needed.
|
|
|
|
## Technical Assumptions
|
|
|
|
This is where we can list information mostly to be used by the architect to produce the technical details. This could be anything we already know or found out from the user at a technical high level. Inquire about this from the user to get a basic idea of languages, frameworks, knowledge of starter templates, libraries, external apis, potential library choices etc...
|
|
|
|
### Testing requirements
|
|
|
|
How will we validate functionality beyond unit testing? Will we want manual scripts or testing, e2e, integration etc... figure this out from the user to populate this section
|
|
|
|
## Epic Overview (MVP / Current Version)
|
|
|
|
- **Epic {#}: {Title}**
|
|
- Goal: {A concise 1-2 sentence statement describing the primary objective and value of this Epic.}
|
|
- Story {#}: As a {type of user/system}, I want {to perform an action / achieve a goal} so that {I can realize a benefit / achieve a reason}.
|
|
- {Acceptance Criteria List}
|
|
- Story {#}: As a {type of user/system}, I want {to perform an action / achieve a goal} so that {I can realize a benefit / achieve a reason}.
|
|
- {Acceptance Criteria List}
|
|
- **Epic {#}: {Title}**
|
|
- Goal: {A concise 1-2 sentence statement describing the primary objective and value of this Epic.}
|
|
- Story {#}: As a {type of user/system}, I want {to perform an action / achieve a goal} so that {I can realize a benefit / achieve a reason}.
|
|
- {Acceptance Criteria List}
|
|
- Story {#}: As a {type of user/system}, I want {to perform an action / achieve a goal} so that {I can realize a benefit / achieve a reason}.
|
|
- {Acceptance Criteria List}
|
|
|
|
--- OPTIONAL UI UX SECTION START ----
|
|
|
|
## UI/UX Specification
|
|
|
|
### Overall UX Goals & Principles
|
|
|
|
- **Target User Personas:** {Reference personas or briefly describe key user types and their goals.}
|
|
- **Usability Goals:** {e.g., Ease of learning, efficiency of use, error prevention.}
|
|
- **Design Principles:** {List 3-5 core principles guiding the UI/UX design - e.g., "Clarity over cleverness", "Consistency", "Provide feedback".}
|
|
|
|
### Information Architecture (IA)
|
|
|
|
- **Site Map / Screen Inventory:**
|
|
```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.}
|
|
|
|
### User Flows
|
|
|
|
{Detail key user tasks. Use diagrams or descriptions.}
|
|
|
|
#### {User Flow Name, e.g., User Login}
|
|
|
|
- **Goal:** {What the user wants to achieve.}
|
|
- **Steps / Diagram:**
|
|
```mermaid
|
|
graph TD
|
|
Start --> EnterCredentials[Enter Email/Password];
|
|
EnterCredentials --> ClickLogin[Click Login Button];
|
|
ClickLogin --> CheckAuth{Auth OK?};
|
|
CheckAuth -- Yes --> Dashboard;
|
|
CheckAuth -- No --> ShowError[Show Error Message];
|
|
ShowError --> EnterCredentials;
|
|
```
|
|
_(Or: Link to specific flow diagram in Figma/Miro)_
|
|
|
|
#### {Another User Flow Name}
|
|
|
|
{...}
|
|
|
|
### Wireframes & Mockups
|
|
|
|
{Reference the main design file link above. Optionally embed key mockups or describe main screen layouts.}
|
|
|
|
- **Screen / View Name 1:** {Description of layout and key elements. Link to specific Figma frame/page.}
|
|
- **Screen / View Name 2:** {...}
|
|
|
|
### Component Library / Design System Reference
|
|
|
|
{Link to the primary source (Storybook, Figma Library). If none exists, define key components here.}
|
|
|
|
#### {Component Name, e.g., Primary Button}
|
|
|
|
- **Appearance:** {Reference mockup or describe styles.}
|
|
- **States:** {Default, Hover, Active, Disabled, Loading.}
|
|
- **Behavior:** {Interaction details.}
|
|
|
|
#### {Another Component Name}
|
|
|
|
{...}
|
|
|
|
### Branding & Style Guide Reference
|
|
|
|
{Link to the primary source or define key elements here.}
|
|
|
|
- **Color Palette:** {Primary, Secondary, Accent, Feedback colors (hex codes).}
|
|
- **Typography:** {Font families, sizes, weights for headings, body, etc.}
|
|
- **Iconography:** {Link to icon set, usage notes.}
|
|
- **Spacing & Grid:** {Define margins, padding, grid system rules.}
|
|
|
|
### Accessibility (AX) Requirements
|
|
|
|
- **Target Compliance:** {e.g., WCAG 2.1 AA}
|
|
- **Specific Requirements:** {Keyboard navigation patterns, ARIA landmarks/attributes for complex components, color contrast minimums.}
|
|
|
|
### Responsiveness
|
|
|
|
- **Breakpoints:** {Define pixel values for mobile, tablet, desktop, etc.}
|
|
- **Adaptation Strategy:** {Describe how layout and components adapt across breakpoints. Reference designs.}
|
|
|
|
--- OPTIONAL UI UX SECTION END ----
|
|
|
|
## Key Reference Documents
|
|
{Will be populated at a later time}
|
|
|
|
## Out of Scope Ideas Post MVP
|
|
|
|
Anything you and the user agreed it out of scope or can be removed from scope to keep MVP lean. Consider the goals of the PRD and what might be extra gold plating or additional features that could wait until the MVP is completed and delivered to assess functionality and market fit or usage.
|
|
|
|
## Change Log
|
|
|
|
| Change | Date | Version | Description | Author |
|
|
| ------------- | ---------- | ------- | ---------------------------- | -------------- |
|
|
|
|
----- END PRD START CHECKLIST OUTPUT ------
|
|
|
|
## Checklist Results Report
|
|
|
|
----- END Checklist START Architect Prompt ------
|
|
|
|
## Initial Architect Prompt
|
|
|
|
Based on our discussions and requirements analysis for the {Product Name}, I've compiled the following technical guidance to inform your architecture analysis and decisions to kick off Architecture Creation Mode:
|
|
|
|
### Technical Infrastructure
|
|
|
|
- **Starter Project/Template:** {Information about any starter projects, templates, or existing codebases that should be used}
|
|
- **Hosting/Cloud Provider:** {Specified cloud platform (AWS, Azure, GCP, etc.) or hosting requirements}
|
|
- **Frontend Platform:** {Framework/library preferences or requirements (React, Angular, Vue, etc.)}
|
|
- **Backend Platform:** {Framework/language preferences or requirements (Node.js, Python/Django, etc.)}
|
|
- **Database Requirements:** {Relational, NoSQL, specific products or services preferred}
|
|
|
|
### Technical Constraints
|
|
|
|
- {List any technical constraints that impact architecture decisions}
|
|
- {Include any mandatory technologies, services, or platforms}
|
|
- {Note any integration requirements with specific technical implications}
|
|
|
|
### Deployment Considerations
|
|
|
|
- {Deployment frequency expectations}
|
|
- {CI/CD requirements}
|
|
- {Environment requirements (local, dev, staging, production)}
|
|
|
|
### Local Development & Testing Requirements
|
|
|
|
{Include this section only if the user has indicated these capabilities are important. If not applicable based on user preferences, you may remove this section.}
|
|
|
|
- {Requirements for local development environment}
|
|
- {Expectations for command-line testing capabilities}
|
|
- {Needs for testing across different environments}
|
|
- {Utility scripts or tools that should be provided}
|
|
- {Any specific testability requirements for components}
|
|
|
|
### Other Technical Considerations
|
|
|
|
- {Security requirements with technical implications}
|
|
- {Scalability needs with architectural impact}
|
|
- {Any other technical context the Architect should consider}
|
|
|
|
----- END PM Prompt -----
|
|
|