Cursor rule

1---
2description:
3globs:
4alwaysApply: false
5---
6# Generate and Maintain `docs/PRD.md` (Product Requirements Document)
7 
8**Your Core Task: Create or update the `docs/PRD.md` file. This document MUST strictly adhere to the 8-section structure defined below. Populate its content SOLELY by extracting and synthesizing information from `NOTES.md` (or a user-provided equivalent source). If critical information for a section is genuinely absent from this source, and only then, insert a specific `<!-- TODO: ... -->` comment.**
9 
10## File Existence Check
11 
12Confirm available source files first:
13 
14```bash
15ls . docs
16```
17 
18Use these results before proceeding.
19 
20Your entire output for this rule invocation **MUST BE ONLY** the complete, raw Markdown content of the `docs/PRD.md` file.
21 
22## I. Strict Operational Constraints (MANDATORY)
23 
24- **Permitted File Operations:**
25    - **Read-Only:** `NOTES.md` (or the specified primary input document if different).
26    - **Read/Write:** `docs/PRD.md` (this is the only file you will modify or create).
27    - **No Other Files:** Do not access, read, or write any other files in the project.
28- **Communication Protocol (ABSOLUTE):**
29    - **NO Conversational Output:** You are strictly forbidden from generating ANY conversational output, commentary, preamble, introductions, or summaries before, during, or after generating the `docs/PRD.md` content.
30    - **Sole Output = File Content:** Your *only* output is the complete Markdown content intended for `docs/PRD.md`.
31- **User Interaction (Handled via TODOs in `docs/PRD.md`):**
32    - You operate based on an implicit or explicit request to manage `docs/PRD.md`.
33    - You do not converse directly with the user during this process.
34    - Deficiencies in information (requiring a TODO) are handled *within* the `docs/PRD.md` file itself, as per the TODO logic below.
35 
36## II. The Blueprint: `docs/PRD.md` Structure & Content Source
37 
38The `docs/PRD.md` file **MUST** be organized into the following eight sections. The questions/points within each item of the "PRD Section Outline" (below) define the required content and also serve as the basis for any necessary `<!-- TODO: ... -->` comments if information is missing from the `NOTES.md` (or equivalent designated source document).
39 
40### PRD Section Outline (Mandatory Structure for `docs/PRD.md`)
41 
421.  **`## 1. Core Functionality & Purpose`**
43    - What is the primary problem this product/feature solves for the end-user?
44    - What is the core functionality required to address this problem?
45 
462.  **`## 2. Key Goals & Scope`**
47    - What are the critical objectives for this product/feature (e.g., target user impact, business goals, technical achievements like performance benchmarks or specific integrations)?
48    - What items are explicitly out-of-scope for the current development cycle or version?
49 
503.  **`## 3. User Interaction & Design Insights`**
51    - Who is the primary user type (e.g., API consumer, web application user, internal admin)?
52    - Describe the primary ways users will interact with the core features (reference UI mockups, API contracts, user flow diagrams if available in `NOTES.md` or linked external resources).
53 
544.  **`## 4. Essential Features & Implementation Highlights`**
55    - List the absolute must-have functionalities for the initial version/MVP.
56    - Provide high-level implementation considerations or key components for each essential feature.
57 
585.  **`## 5. Acceptance Criteria & Definition of "Done"`**
59    - For each key feature or user story, what are the specific, measurable, achievable, relevant, and time-bound (SMART) conditions that must be met for it to be considered "done"?
60    - How will successful completion be verified (e.g., specific tests, user validation scenarios)?
61 
626.  **`## 6. Key Requirements & Constraints`**
63    - List any non-negotiable technical requirements (e.g., target platform, specific languages/frameworks if mandated, required third-party integrations).
64    - List key non-functional requirements (NFRs) such as performance targets (latency, throughput), scalability needs, security standards (compliance, data privacy), reliability goals (uptime), and any known constraints (e.g., infrastructure limitations, budget, timelines).
65 
667.  **`## 7. Success Metrics`**
67    - How will the success of this product/feature be measured post-deployment from a user and business perspective (e.g., user adoption rate, task completion time, error rates, conversion rates, revenue impact)?
68    - (Optional, if distinct from above) How will the development team measure technical success (e.g., system stability, maintainability, code quality metrics)?
69 
708.  **`## 8. Development Logistics & Lookahead`**
71    - Identify significant technical risks, challenges, or dependencies. Include initial thoughts on mitigation strategies.
72    - List major assumptions being made that, if incorrect, could impact development.
73    - Briefly consider future development aspects or extensibility points that current design choices should accommodate.
74 
75## III. Workflow for Generating/Updating `docs/PRD.md`
76 
771.  **Access Source Document (`NOTES.md` or equivalent):**
78    - Read the content of `NOTES.md` (or the user-specified primary input document).
79    - *This is your ONLY source of information for populating `docs/PRD.md`.* If this document is missing or sparse, the `PRD.md` will reflect that (potentially with many TODOs).
80    - Read the current content of `docs/PRD.md` if it already exists (for context during updates).
81 
822.  **Manage `docs/PRD.md` Content:**
83    - **Initialization:** If `docs/PRD.md` does not exist, create it. Your output will be the initial version containing all eight section headers (as listed in the "PRD Section Outline") followed by content or TODOs as per the logic below.
84    - **Content Integration (Section by Section):** For each of the eight mandatory sections:
85        - Review `NOTES.md` (and `docs/PRD.md` itself if updating) for information relevant to *that specific section*.
86        - Synthesize and write the information into the corresponding section of your `docs/PRD.md` output. If updating existing content, intelligently merge or replace based on the latest available information from `NOTES.md`. Aim for comprehensive but concise statements directly addressing the points in the outline.
87 
883.  **Identify Gaps & Insert TODOs (Strict Logic):**
89    - After attempting to populate a section using **only `NOTES.md` (or the specified equivalent source)**:
90        - A `<!-- TODO: ... -->` comment **MUST ONLY** be inserted if the section in your generated `docs/PRD.md` remains **genuinely empty** OR contains only placeholder text (e.g., a simple rephrasing of the section title without any substantive information from `NOTES.md`) OR if critical information explicitly requested by that section's definition (as per the "PRD Section Outline") is **clearly missing** and **cannot be found in `NOTES.md`**.
91        - **DO NOT** insert a TODO if the section has been populated with *any* relevant information from `NOTES.md`, even if that information could theoretically be more detailed. The purpose of the TODO is to flag *critically missing information that was not found in the designated `NOTES.md` source*, not to solicit further details on already present information.
92        - **TODO Comment Format:** `<!-- TODO: [Question from the "PRD Section Outline" for the missing piece of information. Be specific to the context if possible.] -->`
93            - Example for section 1 if core problem isn't in `NOTES.md`: `<!-- TODO: What is the primary problem this product/feature solves for the end-user? (Expected in NOTES.md) -->`
94            - Example for section 5 if acceptance criteria are absent: `<!-- TODO: What are the specific, testable acceptance criteria for key feature X? (Expected in NOTES.md) -->`
95 
964.  **Final Output:** Your *sole output* is the complete, updated content of `docs/PRD.md`.
97 
98Immediately after providing this file content, output a short executive summary of the key sections you filled in or noted as TODOs. Keep this summary separate from the file content.
99 
100**REMEMBER: Your output MUST ONLY be the full Markdown content for `docs/PRD.md`. Populate it strictly from `NOTES.md` (or specified primary source). Follow the 8-section structure. Insert `<!-- TODO: ... -->` comments (containing the relevant guiding question from the outline) ONLY for sections where critical information is verifiably absent from the specified source document.**
101