google / site-kit-wp

Site Kit is a one-stop solution for WordPress users to use everything Google has to offer to make them successful on the web.
https://sitekit.withgoogle.com
Apache License 2.0
1.25k stars 291 forks source link

Address inconsistencies with punctuation in copy #6720

Closed techanvil closed 9 months ago

techanvil commented 1 year ago

Feature Description

There is a bit of inconsistency with the way punctuation is applied in the plugin. For a specific example, see the Analytics settings view:

image.png

We should audit the plugin for any such inconsistencies, and fix them.


Do not alter or remove anything below. The following sections will be managed by moderators only.

Acceptance criteria

"Skip periods and unnecessary punctuation

To help readers scan text, avoid using periods and other unnecessary punctuation.

Avoid using periods to end single sentences, particularly in: - Labels - Tooltip text - Bulleted lists - Dialog body text - Hyperlinked text

Use periods on: - Multiple sentences - Long or complex sentences, if it suits the context - Any sentence followed by a link"

Implementation Brief

Test Coverage

QA Brief

Changelog entry

jimmymadon commented 11 months ago

@marrrmarrr What is Site Kit's policy on punctuation for statements/sentences? It feels like all full sentences (barring a few exceptions as mentioned in the Issue description) within the plugin do not end with a full-stop, unless there are multiple sentences combined together where a full-stop is obviously needed. Should this be the case throughout our UI?

c.c. @aaemnnosttv @sigal-teller

marrrmarrr commented 10 months ago

@jimmymadon according to the style guide, single-sentence phrases like the ones in the screenshot above should have no full stop. If there is more than one sentence, then it's necessary to separate them with full stops.

Here is the full guidance for reference: "Skip periods and unnecessary punctuation

To help readers scan text, avoid using periods and other unnecessary punctuation.

Avoid using periods to end single sentences, particularly in: - Labels - Tooltip text - Bulleted lists - Dialog body text - Hyperlinked text

Use periods on: - Multiple sentences - Long or complex sentences, if it suits the context - Any sentence followed by a link"

techanvil commented 10 months ago

AC :white_check_mark:

tofumatt commented 10 months ago

IB ✅

wpdarren commented 9 months ago

QA Update: ⚠️

@kuasha420 Other than the first issue highlighted, I am not 100% sure about the others.

Would appreciate your opinion since these aren't multiple sentences.

  1. We have a period in the Ad Blocking Recovery screen.

image

  1. For the user input survey questions, we have a description. Should the description have a period when there is a comma within the text?

image

  1. The same question above. I noticed a period in a few other places. Maybe if there's a comma, then it should have a period.

image image

  1. I found this period on the Dashboard Sharing view-only panel.

image

kuasha420 commented 9 months ago

@wpdarren Thank you for the detailed testing and observation. As mentioned by @bethanylang on Slack, the the periods removed from the lines with commas are fine. I've opened an additional PR to remove the other periods you've found. Cheers.

techanvil commented 9 months ago

Back to you for another pass, @wpdarren.

wpdarren commented 9 months ago

QA Update: ❌

@kuasha420 Just two observations, and I think we are done.

  1. The user input descriptions still have a period. I think we said that they shouldn't. Am I correct?

image

  1. Apologies, I didn't notice this in my first round of testing.

The AdSense 'ready' status screen needs the period removing.

image

wpdarren commented 9 months ago

QA Update: ✅

Verified:

Screenshots ![image](https://github.com/google/site-kit-wp/assets/73545194/053fab5d-4601-4502-b831-62ace5795373) ![image](https://github.com/google/site-kit-wp/assets/73545194/d53469cf-627e-419b-8243-e703ae63acc6) ![image](https://github.com/google/site-kit-wp/assets/73545194/47837c99-fe13-4d9f-94e4-162ff2b1bdc8) ![image](https://github.com/google/site-kit-wp/assets/73545194/80ba08e9-57b2-4696-bf90-d92a11e54e41) ![image](https://github.com/google/site-kit-wp/assets/73545194/766dd6a1-dc32-4b6c-a6b5-d78c4c359d5d) ![image](https://github.com/google/site-kit-wp/assets/73545194/c69d7dba-3283-44eb-a7d5-06f2db845a10) ![image](https://github.com/google/site-kit-wp/assets/73545194/8c2ad19f-fbeb-47a1-9aba-7ae0266a134f) ![image](https://github.com/google/site-kit-wp/assets/73545194/6763c561-a0b8-4e1c-8ba0-feaa2e910f0e) ![image](https://github.com/google/site-kit-wp/assets/73545194/f4723a64-d313-4bd3-a4d0-9c169666bfbc) ![image](https://github.com/google/site-kit-wp/assets/73545194/928d1978-4372-42bf-b587-3a795de36ac9) ![image](https://github.com/google/site-kit-wp/assets/73545194/867253a9-2452-4e88-90d8-63aead793f47) ![image](https://github.com/google/site-kit-wp/assets/73545194/4dd7197f-38c2-4760-a1c1-edd3aec6dc9d) ![image](https://github.com/google/site-kit-wp/assets/73545194/0356cd79-62b6-4b7e-9b97-58b52b94bd71) ![image](https://github.com/google/site-kit-wp/assets/73545194/f149f623-7315-405f-ab9c-70680fd2e418) ![image](https://github.com/google/site-kit-wp/assets/73545194/54444806-3169-4b7b-8c13-f560f43cc475) ![image](https://github.com/google/site-kit-wp/assets/73545194/88644375-4add-4118-a54b-12f32235c627)