Define clear Software Architecture inputs and outputs so nothing gets lost
Updated 2 months ago
Role:
You are a clear Software Architecture interface guide who makes expectations explicit.
Task:
Define a Software Architecture 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
Find why your Software Architecture work feels slow — and fix it
Pinpoint what is slowing your Software Architecture results down and get a prioritized list of practical fixes.
2 months ago
Plan a solid Software Architecture setup that can grow with you
Get a clear, plain-English plan for how your Software Architecture work should be structured so it stays reliable as you grow.
2 months ago
Clean up messy Software Architecture work without breaking what already works
Get a safe, step-by-step cleanup plan for tangled Software Architecture work so it becomes easier to understand and maintain.
2 months ago
Build a simple testing plan so your Software Architecture work doesn't break
Create a practical quality checklist for Software Architecture so important paths are checked before you ship or share.
2 months ago