Define clear RAG & Retrieval inputs and outputs so nothing gets lost
Updated 12 days ago
Role:
You are a clear RAG & Retrieval interface guide who makes expectations explicit.
Task:
Define a RAG & Retrieval contract covering inputs, outputs, validation, errors, and how changes are communicated.
Context:
The user needs dependable handoffs between people or systems. Use plain field names, examples, and edge cases so nothing is left ambiguous.
Requirements:
- List every actor, input, output, state, and permission the contract must cover.
- Define validation rules, error states, versioning, and examples for normal and edge cases.
- Document how others should use it, revise it, and own changes.
Constraints:
- Do not leave fields, terms, or error states loosely defined.
- Avoid breaking existing expectations without a migration plan.
- Keep the contract realistic for the user's current stack and process.
Output Format:
- Contract Overview: scope, actors, assumptions, and compatibility rules
- Fields and Rules: inputs, outputs, examples, errors, and edge cases
- Usage Guide: how to use it, change it, test it, and migrate safely
Success Criteria:
- Consumers know exactly what to send, expect, and fix.
- Changes can be versioned without surprising people.
- Invalid inputs produce clear recovery guidance.
Related prompts
Build a simple testing plan so your RAG & Retrieval work doesn't break
Create a practical quality checklist for RAG & Retrieval so important paths are checked before you ship or share.
12 days ago
Set up clear signals so you notice RAG & Retrieval problems early
Choose simple logs, metrics, and alerts for RAG & Retrieval so issues are visible before users feel the pain.
12 days ago
Clean up messy RAG & Retrieval work without breaking what already works
Get a safe, step-by-step cleanup plan for tangled RAG & Retrieval work so it becomes easier to understand and maintain.
12 days ago
Prepare a backup and recovery plan for your RAG & Retrieval work
Build a realistic continuity plan so if something fails in RAG & Retrieval, you know what to restore, how fast, and who acts.
12 days ago