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

Write Strong

ORIGINAL:

Amazon Elastic Container Registry (Amazon ECR) is an AWS managed container image registry service that is secure, scalable, and reliable. Amazon ECR supports private container image repositories with resource-based permissions using AWS IAM. This is so that specified users or Amazon EC2 instances can access your container repositories and images. You can use your preferred CLI to push, pull, and manage Docker images, Open Container Initiative (OCI) images, and OCI compatible artifacts.

BETTER:

Amazon Elastic Container Registry (Amazon ECR) is an AWS managed container image registry service that is secure, scalable, and reliable. Using AWS IAM, Amazon ECR supports private container image repositories with resource-based permissions so that specified users and Amazon EC2 instances can access your container repositories and images. You can use your preferred CLI to push, pull, and manage Docker images, Open Container Initiative (OCI) images, and OCI compatible artifacts.

EXPLANATION:

This sentence is awkward – Amazon ECR supports private container image repositories with resource-based permissions using AWS IAM. – The phrase “using AWS IAM” could technically belong to the resource-based permissions. The reader will likely not misinterpret the sentence, but there is a more direct way to write it. 

“And” should be used instead of “or” in the phrase “so that specified users or Amazon EC2 instances can access your container repositories and images.” “or” is technically okay but the phrase is about the general offerings of AWS ECR so “and” makes a little more sense. For example the sentence, “Students can use the software to post their homework online so that it can be reviewed by teachers and parents” is better than saying “teachers or parents”

Leave a Reply

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