Skip to content

Commit 6162a86

Browse files
authored
Update prompt-engineering.md
1 parent 672b9ae commit 6162a86

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

docs/advanced-usage/prompt-engineering.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -5,11 +5,11 @@ Prompt engineering is the art of crafting effective instructions for AI models l
55
## General Principles
66

77
* **Be Clear and Specific:** Clearly state what you want Roo Code to do. Avoid ambiguity.
8-
* **Bad:** "Fix the code."
9-
* **Good:** "Fix the bug in the `calculateTotal` function that causes it to return incorrect results."
8+
* **Bad:** Fix the code.
9+
* **Good:** Fix the bug in the `calculateTotal` function that causes it to return incorrect results.
1010

1111
* **Provide Context:** Use [Context Mentions](../basic-usage/context-mentions) to refer to specific files, folders, or problems.
12-
* **Good:** `@/src/utils.ts Refactor the \`calculateTotal\` function to use async/await.`
12+
* **Good:** `@/src/utils.ts` Refactor the `calculateTotal` function to use async/await.
1313

1414
* **Break Down Tasks:** Divide complex tasks into smaller, well-defined steps.
1515

@@ -66,7 +66,7 @@ If Roo Code doesn't produce the desired results, you can provide feedback by:
6666

6767
**Good Prompt:**
6868

69-
> @/src/components/Button.tsx Refactor the `Button` component to use the `useState` hook instead of the `useReducer` hook.
69+
> `@/src/components/Button.tsx` Refactor the `Button` component to use the `useState` hook instead of the `useReducer` hook.
7070
7171
**Bad Prompt:**
7272

@@ -82,10 +82,10 @@ If Roo Code doesn't produce the desired results, you can provide feedback by:
8282
8383
**Good Prompt:**
8484

85-
> @problems Address all errors and warnings in the current file.
85+
> `@problems` Address all errors and warnings in the current file.
8686
8787
**Bad Prompt:**
8888

8989
> Fix everything.
9090
91-
By following these tips, you can write effective prompts that get the most out of Roo Code's capabilities.
91+
By following these tips, you can write effective prompts that get the most out of Roo Code's capabilities.

0 commit comments

Comments
 (0)