返回提示词目录第 1414 页

第三方系统集成规格编写

围绕用户目标编写集成规格,明确连接生命周期、字段映射、同步规则与异常处理。

完整提示词

<context>
Integrations are features whose behaviour depends on a system you do not control. Most integration complaints are about things the spec never decided: a field that exists on one side and not the other, a record edited in both products between syncs, a connection that silently stopped because the person who connected it left the company or their token expired, a rate limit hit by the largest customer, and duplicates created on the first sync because there was no matching rule. A good integration spec starts from the user job and the smallest data that serves it, chooses one direction and one source of truth per field, defines the first sync separately from ongoing sync, says what users see when the other side fails, and asks for only the access the job needs.
</context>

<task>
<integration_goal>
{{integration_goal}}
</integration_goal>
{{#known_constraints}}
<known_constraints>
{{known_constraints}}
</known_constraints>
{{/known_constraints}}

1. State the integration scope: the user job, who sets it up (individual or admin, per user or per workspace), which plans get it, and what is explicitly out of scope for the first version.
2. Specify the connection lifecycle: connect flow, access requested and why each is needed, what happens when the connecting person leaves or loses access, reconnect, disconnect, and what data stays or is removed on each side after disconnect.
3. Write a data mapping table: object and field on each side, direction, source of truth, transformation (formats, enums, units, time zones), and behaviour when a field is missing on one side.
4. Write sync rules: first sync (backfill scope and matching to avoid duplicates), ongoing sync trigger and expected delay, conflict resolution when both sides change, deletes, and limits for very large accounts.
5. Specify failure handling: expired access, rate limits, the other service down, validation errors on one record, partial sync; what the user sees, where a sync log is shown, retry behaviour, and who is alerted.
6. List open questions, separating those for the other service's documentation or partnership team from product decisions, each with a recommended default marked as a proposal.
</task>

<constraints>
- Do not state the other service's API capabilities, scopes, rate limits or pricing as fact unless the user supplied them; mark them as "verify in the provider's documentation".
- Request the least access that serves the job, and say which access would need a security or privacy review.
- Every field has exactly one source of truth or an explicit conflict rule; no "keep in sync" without saying how.
- If the user job is unclear, ask what the user wants to achieve before mapping fields.
</constraints>

<output_format>
## Integration scope
Bullets, including out of scope.
## Connection lifecycle
Numbered steps and rules.
## Data mapping
Table: our field, their field, direction, source of truth, transformation, if missing.
## Sync rules
Bullets: first sync, ongoing sync, conflicts, deletes, scale.
## Failure handling
Table: failure, what the user sees, retry, who is alerted.
## Open questions
Two numbered lists: to verify with the provider, product decisions (with recommended defaults as proposals).
</output_format>

可替换内容

  • {{integration_goal}}
  • {{#known_constraints}}
  • {{known_constraints}}
  • {{/known_constraints}}

分类与标签

编程开发、第三方集成、字段映射、数据同步、异常处理

前往 AI 图片创作