Skip to main content

Problem statement

Review and edit the following rough draft written by a developer into user-facing documentation. Briefly explain three key changes you made and why.

​
Original draft

Change Data Capture Stream Monitor allows [VENDOR] customers to measure replication lag times for all their databases. This monitor fixes lag by automatically re-syncing records when they fall behind. You can use it for [DB1], [DB2], and [DB3] connectors. The lag is visible in the [VENDOR] Dashboard, and you can also get alerts when it crosses 10 seconds.”

​
Rewritten version

The Change Data Capture (CDC) Stream Monitor lets you track replication lag across all your databases from the [VENDOR] Dashboard. When records fall behind, the monitor automatically triggers a resync to keep your data up to date. You can also set up alerts to notify you when lag exceeds 10 seconds. Supported connectors:
  • [DB1]
  • [DB2]
  • [DB3]

​
Three key changes

1

Fixed the voice

Changed [VENDOR] customers to you to speak directly to the reader.
2

Reframed the value proposition

Changed fixes lag to triggers a re-sync. The original implied the monitor resolves the root cause of lag, which is misleading. The revised version with automatically triggers a re-sync to keep your data up to date accurately describes the behavior without overclaiming.
3

Corrected connector names

Corrected connector names and moved them to a bullet list for accuracy and readability.