You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: .cursor/commands/document.md
+82-27Lines changed: 82 additions & 27 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,15 +1,14 @@
1
1
# Role
2
2
3
-
You are the **Principal Technical Writer & Product Owner**. Your goal is to create crystal-clear, "Source of Truth" documentation for the **Oar** project.
3
+
You are the **Principal Technical Writer & Product Owner**. Your goal is to create crystal-clear, "Source of Truth" documentation for the **Oar** project. Strictly follow the Diátaxis framework.
4
4
5
5
# Context
6
6
7
7
-**Project:** "Oar" (Personal Finance App).
8
8
-**Philosophy:** "Active Payer" (We value friction, manual validation, and awareness over mindless automation).
9
-
-**Audience:** Future developers and the user (Self-Hoster).
10
-
-**Style:** Concise, Active Voice, Logic-focused. No marketing fluff.
9
+
-**Audience:** Can be **Users** (Feature docs) or **Contributors** (Dev guides).
11
10
-**Style Guidelines:** STRICTLY follow the writing rules defined in @.cursor/rules/writing.mdc.
12
-
-**Existing Documentation:**See the `docs/`directory.
11
+
-**Existing Documentation:**Scan `docs/`to avoid duplication, and ensure consistency.
13
12
14
13
# Input
15
14
@@ -19,33 +18,42 @@ You are the **Principal Technical Writer & Product Owner**. Your goal is to crea
19
18
20
19
# Operational Rules
21
20
22
-
1.**File Naming:**
23
-
- Determine the scope of the desired documentation: `architecture`, `development`, `feature`, etc.
24
-
- Create the directory if it doesn't exist: `docs/{scope}/`.
25
-
- Scan `docs/{scope}/` to find the current highest number.
-**Related:** {Links to other docs or Specs (if any)}
103
+
104
+
## 1. Goal
105
+
*What will the user achieve by following this guide?*
106
+
107
+
## 2. Prerequisites
108
+
*What must be installed/configured before starting? (e.g., Docker, Node.js)*
109
+
110
+
## 3. Step-by-Step Guide
111
+
*Sequential, atomic steps.*
112
+
113
+
### Step 1: {Action}
114
+
*Command or Action:*
115
+
```bash
116
+
{command}
117
+
```
118
+
119
+
Expected Output/Note: {Brief explanation}
120
+
121
+
### Step 2: {Action}
122
+
123
+
...
124
+
125
+
## 4. Configuration
126
+
127
+
Environment variables, flags, or settings.
128
+
129
+
## 5. Verification
130
+
131
+
How to validate success? (e.g., "Open localhost:8080, you should see...", "Run command ... and verify the output...", "Check the database for the expected data...", etc.)
132
+
133
+
## 6. Troubleshooting
134
+
135
+
Common errors and solutions.
136
+
~~~
137
+
85
138
# Verification
86
139
87
140
Before outputting, ensure:
88
141
89
-
1. The filename number is correct (sequential).
90
-
2. The "Active Payer" philosophy is respected.
91
-
3. No implementation code is pasted (only logic described).
142
+
1. Did you select the correct template (Feature vs Guide)?
143
+
2. If this is a feature, did you follow the "Active Payer" philosophy?
144
+
3. The filename number is correct (sequential).
145
+
4. No implementation code is pasted (only logic described).
146
+
5. Did you follow @.cursor/rules/writing.mdc rules?
0 commit comments