The primary goal of technical writing is to provide useful and necessary information.
Write Simple
Write Simple

Write Simple

ORIGINAL:

DynamoDB lets you offload the administrative burdens of operating and scaling a distributed database so that you don’t have to worry about hardware provisioning, setup and configuration, replication, software patching, or cluster scaling. DynamoDB also offers encryption at rest, which eliminates the operational burden and complexity involved in protecting sensitive data. For more information, see DynamoDB Encryption at Rest.

BETTER:

DynamoDB lets you offload the administrative tasks required to operate and scale a distributed database, which means you don’t have to provision hardware, setup and configure servers, implement replication, patch software, or scale clusters. DynamoDB can be configured to encrypt data at rest; protecting your sensitive data during storage. For more information, see DynamoDB Encryption at Rest.

EXPLANATION:

The original sentence is relatively fine. The “better” passage is created with the goal of keeping the passage as simple as possible. For example, the phrase “burdens of” can be written more simply. The “better” passage assumes that “administrative tasks” are inherently burdensome and this point does not need to be made. The phrase “burdensome administrative tasks required…” could be used instead and it would still be more simple writing than “burdens of operating…”

The phrase “you don’t have to worry about” is logically problematic because a literal reading could mean that you still have to perform those tasks, you just don’t have to worry. Of course the reader is unlikely to have this confusion, but it is more simple writing to mention the tasks in a physical sense.

Using just “offers” in the phrase “offers encryption at rest” provides the same information to the reader as “also offers encryption at rest”.

Leave a Reply

Your email address will not be published. Required fields are marked *