Skip to content

Commit f7298ca

Browse files
docs: refine prompting guideline examples
🤖 Generated with [Pochi](https://getpochi.com) Co-Authored-By: Pochi <[email protected]>
1 parent f09410e commit f7298ca

File tree

1 file changed

+7
-5
lines changed

1 file changed

+7
-5
lines changed

packages/docs/content/docs/prompting-guideline.mdx

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,8 @@ Output: `const cache = require('node-cache'); cache.set('users', await db.query(
4646

4747
For complex logic, request step-by-step reasoning.
4848

49-
**E.g.,**“Debug `@main.py`: Identify the null reference issue in `fetchUser()`, propose a fix, test with `pytest test_main.py`, log the result."
49+
**Example:**
50+
“Debug `@main.py`: Identify the null reference issue in `fetchUser()`, propose a fix, test with `pytest test_main.py`, log the result."
5051

5152
### Use Structured Prompts
5253

@@ -85,13 +86,15 @@ Apply structured formats (XML or JSON) for precision, repeatability, and task ch
8586

8687
Specify a role in the prompt or via `.pochi/agents/` to enforce standards.
8788

88-
**E.g.,** “Act as linter for `@models/db.py` per `README.pochi.md`, focusing on PEP 8 spacing issues.”
89+
**Example:**
90+
“Act as linter for `@models/db.py` per `README.pochi.md`, focusing on PEP 8 spacing issues.”
8991

9092
### Chain Complex Prompts
9193

9294
Divide large tasks into numbered steps for manageability.
9395

94-
**E.g.,** “Step 1: Review `@api.py` for existing `/users` route, Step 2: Add `/users` GET endpoint with Flask-Login authentication.”
96+
**Example:**
97+
“Step 1: Review `@api.py` for existing `/users` route, Step 2: Add `/users` GET endpoint with Flask-Login authentication.”
9598

9699
## Task-Specific Applications
97100

@@ -131,7 +134,7 @@ This section applies prompting patterns to common development workflows, from pr
131134

132135
### Performance Optimization
133136

134-
- **Profiling Latency:** “Profile `@api.js`: Identify `/users` bottlenecks, suggest caching (e.g., `cache.set(...)`), target <300ms latency, log as `{ latency: Xms }` JSON.”
137+
- **Profiling Latency:** “Profile `@api.js`: Identify `/users` bottlenecks, suggest caching (e.g., `cache.set(...)`), target `<300ms` latency, log as `{ latency: Xms }` JSON.”
135138
- **Query Optimization:** “Optimize `@services/db.js`: Improve a slow SELECT query, propose an index, log performance gain as `{ gain: Y% }` JSON.”
136139
- **Resource Check:** “Audit `@api.js`: Reduce `/users` memory usage by 20%, document changes separately.”
137140

@@ -140,4 +143,3 @@ This section applies prompting patterns to common development workflows, from pr
140143
- **Adding Inline Comments:** “Document `@api.js`: Add comments to `/users` GET explaining auth flow.”
141144
- **Updating Project Docs:** “Update `README.pochi.md`: Summarize `@api.js` `/users` changes, list endpoints, enforce rules.”
142145
- **Generating API Specs:** “Create `@api.js` docs: Write OpenAPI specs for `/users` and `/orders`, save to `docs/api.md`.”
143-

0 commit comments

Comments
 (0)