[CMSP-791] WP-CLI changes did not use clear and consistent language #8818
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
Troubleshoot WP-CLI - Changed to use clear language
Clarity and accessibility: The replacement of "What's the TL;DR?" with "Summary of changes" in the alert title improves clarity and accessibility. Avoiding internet slang and using straightforward language makes the document more accessible to screen readers and a global audience.
The removal of colloquial language like "gymnastics" is also crucial for a global audience. Technical documentation should be written in a way that is easily understandable by people from various cultural and linguistic backgrounds.
Technical terms All references now use the standard lowercase display of
stdout
instead of the previous mixed-case output. I have also defined the original term "standard output (stdout
)" as this is a new term on the page.Standard second person writing Pantheon's documentation should address the user as "you" and define the speaking voice, for example "At Pantheon, we do..." instead of using "I have called..."
Release:
Post Launch
Do not remove - To be completed by the docs team upon merge:
/old-path/
=>/new-path/
(if applicable)