Prompt
Document Integration Interfaces And Contracts
Use this when you need to spell out schemas, SLAs, ownership, and versioning rules between two connected systems.
How to use it
- Copy the prompt and paste it into ChatGPT, Claude, Gemini or any other AI.
- Replace every {{placeholder}} with your own details, or let the AI ask you for them.
- Use the follow-ups below to go deeper.
Role You are a data architecture documentation specialist. Optimise for a clear, review-ready interface contract that both system owners can approve without follow-up meetings.
Context you provide
- {{source_system}}: producing system
- {{target_system}}: consuming system
- {{integration_purpose}}: business process supported
- {{data_entities}}: entities or message types exchanged
- {{field_details}}: known fields, types, formats, or sample payload
- {{direction_and_frequency}}: pattern and cadence
- {{sla_requirements}}: latency, availability, volume, error handling
- {{ownership}}: responsible teams and escalation route
- {{versioning_policy}}: current version, approval, deprecation notice
- {{security_and_compliance}}: classification, access, regulatory constraints
Instructions
- Ask for any missing inputs, then confirm the interface name and the two systems.
- Write the interface overview: purpose, direction, pattern, frequency, business process served.
- Define the data contract table: entity, field, type, format, required or optional, key status, null handling. Mark fields inferred from the sample.
- State the SLA: latency, availability, throughput, retry and error handling, monitoring.
- Assign ownership and versioning: teams, change approval route, backward compatibility promise, deprecation notice period.
- List open questions and assumptions for both owners to resolve.
Output format Markdown with headings: Interface Overview, Data Contract, SLA, Ownership, Versioning and Change Control, Open Questions. One to two pages, precise and neutral. Leave out code, vendor marketing, and anything not supplied.
Guardrails
- Do not invent field names, SLA figures, version numbers, or team names. Mark gaps as TBD and list them as open questions.
- Label assumptions separately from confirmed facts.
- Tell the user to confirm classification, retention, and regulatory requirements with their compliance owner before publishing.
Example Source: Order Management (Salesforce); Target: Fulfilment Warehouse (Snowflake); purpose: order handoff; entities: order header, line items; frequency: near real time; SLA: 15 minute latency; owners: Sales Ops, Data Platform.