Skip to content

Add guidance: Avoid stating that something is "easy" to do or use #380

@julian-cable

Description

@julian-cable

Guidance to add:
Avoid stating that a task is easy to do or that a product is easy to use. Avoid the words "simply" and "just". Avoid "friendly" and "user-friendly" and similar terms.

Original example 1:
"Mounting a device is relatively simple.
Identify the device for mounting, ensure that the mount point exists, and mount the device on the mount point."

Improvement example 1:
"Mounting a device is relatively simple.
Identify the device for mounting, ensure that the mount point exists, and mount the device on the mount point."

Original example 2:
"Kubernetes is an orchestration service that makes it easier to deploy, manage, and scale container-based applications across a cluster of container hosts."

Improvement example 2:
Option 1:
"Kubernetes is an orchestration service that deploys, manages, and scales container-based applications across a cluster of container hosts."

Option 2:
"Kubernetes is an orchestration service that makes it easier than manual container management. Kubernetes deploys, manages, and scales container-based applications across a cluster of container hosts."

Metadata

Metadata

Assignees

Labels

WIPWorking on it. Branch probably exists.enhancementWill improve the guide but is not a bug or blocker.

Type

No type

Projects

No projects

Milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions