ref

Appendix A

Appendix A

Quick reference checklist for writing effective prompts.

Appendix A: Context Engineering Checklist

Use this checklist when writing prompts for AI coding tools.


Before You Prompt

  • Am I starting a fresh chat for this task?
  • Have I identified which files are relevant?
  • Do I know what output I want?

The 10-Rule Checklist

//1. Task Context

  • Did I tell the AI its role? ("You are a senior Python developer...")
  • Did I specify the goal? ("...helping debug a Django API")

//2. Tone and Boundaries

  • Did I specify how to behave? (concise, technical, ask if unsure)
  • Did I set any constraints? (don't modify X, stay within Y)

//3. Background Knowledge

  • Did I include tech stack info if relevant?
  • Did I mention any patterns or conventions to follow?

//4. Task Steps

  • Did I spell out the procedure if it's complex?
  • Is it clear what order to do things in?

//5. Examples

  • Would an example output help? Include one.
  • Are there patterns the AI should imitate?

//6. Relevant History

  • Did I include prior decisions if relevant?
  • Did I EXCLUDE unrelated history?

//7. Current Request at End

  • Is my actual question/request stated clearly at the END?
  • After all context, is it obvious what I want?

//8. Step-by-Step Thinking

  • For complex tasks, did I ask the AI to reason through it?

//9. Output Format

  • Did I specify the format I need? (JSON, bullet points, etc.)
  • Will I be able to use the output without reformatting?

//10. Prefill (Optional)

  • Would starting the response for the AI help?

Quick Reference: Intent vs State

Intent Context (What You Want)State Context (What Exists)
"Explain why..."The code in question
"Refactor to..."Current implementation
"Fix the bug where..."Error messages
"Create a function that..."Related existing code
"Optimize for..."Performance metrics

You need BOTH for good results.


Common Context Mistakes

MistakeFix
No error message includedAlways paste the full error
Whole codebase dumpedInclude only relevant files
Intent unclearState what you want explicitly
Old conversation dragged inStart fresh chat
Assuming AI knows your stackInclude tech stack in rules

Copy-Paste Prompt Structure

[ROLE] You are a [expertise level] [technology] developer. [GOAL] Your goal is to [specific objective]. [CONTEXT] Here's the relevant code: @file path/to/relevant/file.ts [CONSTRAINTS] - Follow existing patterns in the codebase - Don't modify [specific files/functions] - [Any other constraints] [TASK] [Your specific request here] [OUTPUT FORMAT] Please provide: 1. [First thing you want] 2. [Second thing you want]