developer-ai 1.0.0

package/skills/prompt-engineering/SKILL.md

@@ -0,0 +1,362 @@
+---
+name: prompt-engineering
+description: Guide for writing effective prompts for AI assistants and LLMs. Use when crafting prompts for code generation, documentation, debugging assistance, or other AI-assisted tasks. Covers prompt structure, context management, and iteration techniques.
+---
+
+# Prompt Engineering Skill
+
+This skill provides guidance for crafting effective prompts to get better results from AI assistants.
+
+## Overview
+
+Good prompts lead to better AI outputs. This skill covers techniques for structuring prompts, providing context, and iterating to improve results.
+
+## Prompt Structure
+
+### Basic Structure
+
+```
+[Context] - Background information
+[Task] - What you want done
+[Format] - How you want the output
+[Constraints] - Limitations or requirements
+```
+
+### Example
+
+```
+Context: I'm building a React e-commerce site with TypeScript.
+
+Task: Create a product card component that displays an image,
+title, price, and "Add to Cart" button.
+
+Format: Provide the component code with TypeScript types.
+
+Constraints:
+- Use CSS modules for styling
+- Include hover effects
+- Make it accessible (ARIA labels)
+```
+
+## Effective Prompting Techniques
+
+### Be Specific
+
+```
+❌ Vague: "Write a function to process data"
+
+✓ Specific: "Write a TypeScript function that:
+- Takes an array of user objects with name, email, and age
+- Filters to users over 18
+- Returns a new array with only name and email
+- Sorts by name alphabetically"
+```
+
+### Provide Context
+
+```
+❌ No context: "Fix this bug"
+
+✓ With context: "This function should return the sum of all
+positive numbers in the array, but it's returning 0 for
+[1, -2, 3, -4, 5]. The expected result is 9.
+
+function sumPositive(numbers) {
+  return numbers.filter(n => n > 0).reduce((a, b) => a + b);
+}"
+```
+
+### Show Examples
+
+```
+I want to convert camelCase to kebab-case.
+
+Examples:
+- "myVariable" → "my-variable"
+- "handleClick" → "handle-click"
+- "XMLParser" → "xml-parser"
+
+Write a function that handles these cases.
+```
+
+### Specify Format
+
+```
+Explain how React's useEffect hook works.
+
+Format your response as:
+1. One-sentence summary
+2. When to use it (3 bullet points)
+3. Code example with comments
+4. Common mistakes to avoid
+```
+
+### Use Step-by-Step Instructions
+
+```
+Help me refactor this code. Let's do it step by step:
+
+1. First, identify the repeated code patterns
+2. Then, suggest what to extract into separate functions
+3. Show me the refactored code
+4. Explain any tradeoffs
+
+[code here]
+```
+
+## Context Management
+
+### Include Relevant Code
+
+```
+I'm getting a TypeScript error. Here's the relevant context:
+
+// types.ts
+interface User {
+  id: string;
+  name: string;
+}
+
+// userService.ts
+function getUser(id: number): User {  // Error here
+  return users.find(u => u.id === id);
+}
+
+The error says: "Type 'number' is not assignable to type 'string'"
+```
+
+### Specify Technologies
+
+```
+Tech stack:
+- Next.js 14 with App Router
+- TypeScript
+- Prisma with PostgreSQL
+- Tailwind CSS
+
+Create an API route that fetches all posts with pagination.
+```
+
+### Reference Documentation
+
+```
+According to React Query v5 docs, queries now use
+object syntax. Update this code to the new format:
+
+const { data } = useQuery('users', fetchUsers);
+```
+
+## Prompts for Common Tasks
+
+### Code Review
+
+```
+Review this code for:
+1. Bugs or potential issues
+2. Performance problems
+3. Security vulnerabilities
+4. Code style improvements
+
+Don't rewrite the code, just list the issues with
+brief explanations.
+
+[code here]
+```
+
+### Debugging
+
+```
+This function isn't working as expected.
+
+Current behavior: [what happens]
+Expected behavior: [what should happen]
+What I've tried: [debugging steps taken]
+
+[code here]
+
+Help me find the bug.
+```
+
+### Explaining Code
+
+```
+Explain this code to me:
+- What does it do overall?
+- Walk through it line by line
+- Why might someone write it this way?
+- Are there simpler alternatives?
+
+[code here]
+```
+
+### Writing Tests
+
+```
+Write unit tests for this function using Vitest syntax.
+
+Cover these cases:
+1. Normal inputs
+2. Edge cases (empty, null, undefined)
+3. Error conditions
+
+[function here]
+```
+
+### Documentation
+
+```
+Write JSDoc documentation for this function including:
+- Brief description
+- Parameter descriptions with types
+- Return value description
+- Usage example
+- Potential errors thrown
+
+[function here]
+```
+
+## Iteration Techniques
+
+### Refine Incrementally
+
+```
+Round 1: "Create a user authentication system"
+   ↓
+Round 2: "Add password validation requiring 8+ chars,
+          one number, and one special character"
+   ↓
+Round 3: "Add rate limiting to prevent brute force attacks"
+```
+
+### Ask for Alternatives
+
+```
+You provided Option A. Now show me:
+- Option B: A more performant approach
+- Option C: A more readable approach
+- Which would you recommend and why?
+```
+
+### Request Explanations
+
+```
+That solution works, but I don't understand why you used
+[specific technique]. Explain the reasoning and show me
+what would happen if I used [alternative] instead.
+```
+
+## Anti-Patterns to Avoid
+
+### Too Vague
+
+```
+❌ "Help me code"
+❌ "Make this better"
+❌ "Write some tests"
+```
+
+### Too Much at Once
+
+```
+❌ "Build me a complete e-commerce site with user auth,
+    payment processing, inventory management, admin
+    dashboard, analytics, and mobile app"
+
+✓ Break into smaller requests:
+  1. "Design the database schema for products and orders"
+  2. "Create the product listing API"
+  3. "Add shopping cart functionality"
+  ...
+```
+
+### Missing Context
+
+```
+❌ "Why doesn't this work?"
+   (without showing the code or error)
+
+✓ "This code throws 'undefined is not a function' on line 5.
+   I expect it to return an array of names.
+   [code here]"
+```
+
+### Overly Constrained
+
+```
+❌ "Write the exact code that will solve my problem
+    without any changes needed"
+
+✓ "Provide a starting point that I can adapt to my
+    specific needs"
+```
+
+## Prompt Templates
+
+### Feature Implementation
+
+```
+Feature: [description]
+
+Context:
+- Stack: [technologies]
+- Existing code: [relevant files/functions]
+- Dependencies: [related features]
+
+Requirements:
+- [requirement 1]
+- [requirement 2]
+
+Constraints:
+- [constraint 1]
+- [constraint 2]
+```
+
+### Bug Fix
+
+```
+Bug: [brief description]
+
+Steps to reproduce:
+1. [step 1]
+2. [step 2]
+
+Current behavior: [what happens]
+Expected behavior: [what should happen]
+
+Code:
+[relevant code]
+
+Error message (if any):
+[error]
+```
+
+### Code Explanation
+
+```
+Please explain this code:
+
+[code]
+
+Specifically:
+- What is the purpose?
+- How does [specific part] work?
+- Why use [specific technique]?
+```
+
+## Tips for Better Results
+
+1. **Start Simple** - Begin with basic requests, add complexity incrementally
+
+2. **Use Examples** - Show input/output examples when possible
+
+3. **Specify Constraints** - Mention framework versions, coding standards, etc.
+
+4. **Ask for Reasoning** - "Explain why" leads to better understanding
+
+5. **Iterate** - Don't expect perfection on first try
+
+6. **Be Precise** - Ambiguity leads to wrong assumptions
+
+7. **Provide Error Messages** - Full error text helps debugging
+
+8. **Set Scope** - Define what's in/out of scope clearly