1.4 KiB
[Domain Name] Adapter Detailed Implementation Spec
Date: [YYYY-MM-DD]
Status: [Draft | In Review | Approved]
Owner: [Name]
Reviewers: [Names]
Scope: [Oracle | CRM | Catalyst | Sentinel | Other]
Purpose: Define the exact adapter behavior, request and response contracts, file placements, runtime flow, and acceptance criteria for the target domain.
1. Purpose
State what this adapter exists to translate.
2. Adapter Strategy
Describe:
- why this adapter exists
- why this domain is in scope now
- what the adapter must not try to own
3. Mission Type
State the mission types supported by the adapter.
4. Entry Points
List:
- routes
- UI actions
- service triggers
5. Context Inputs
List every input the adapter requires.
6. File Placement
State all Python and TypeScript files to create or modify.
7. Mission Creation Flow
Describe the exact step-by-step runtime flow.
8. Output Contract
Describe:
- final answer payload
- artifacts returned
- writeback proposal shape
9. Writeback Rules
State what may be proposed and what approval is required.
10. Acceptance Criteria
Define the adapter completion gate.
11. Tests
List required unit, integration, and replay tests.
12. Demo and Sales Relevance
State why this adapter matters to the product and to demos.
13. Bottom Line
Summarize the adapter contract.