Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docs: Copy terms & style guide #1832

Merged
merged 1 commit into from
Dec 22, 2023
Merged

Docs: Copy terms & style guide #1832

merged 1 commit into from
Dec 22, 2023

Conversation

machikoyasuda
Copy link
Member

closes #1653

image image image image

@machikoyasuda machikoyasuda requested a review from a team as a code owner December 18, 2023 21:49
@github-actions github-actions bot added the documentation [auto] Improvements or additions to documentation label Dec 18, 2023
@machikoyasuda machikoyasuda self-assigned this Dec 18, 2023
@machikoyasuda machikoyasuda added this to the Copy Improvements milestone Dec 18, 2023
Copy link

Coverage report

The coverage rate went from 90.87% to 90.87% ➡️
The branch rate is 85%.

None of the new lines are part of the tested code. Therefore, there is no coverage data about them.

@machikoyasuda
Copy link
Member Author

@angela-tran Now rebased and ready for review!

@@ -0,0 +1,46 @@
# Copy terms and style

Use the following terms and style rules for Benefits application English and Spanish copy. Refer to the [Cal-ITP Editorial Style Guide](https://docs.google.com/document/d/1yG2jc_aMPSGc2wqvazKGgFIeV-aDDDsJIuONhUg0MOI/edit) and [Language Matters: Cal-ITP Terminology](https://docs.google.com/document/d/1ud73Qaa7k6I5l8MwlQrZd8iOo7_3shZHy_gCxfAe0eY/edit#heading=h.keo0rpgsdx29) for further guidance.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for linking to these. Reading through them again and more closely, I realized we've had copy questions in the past that could've been answered by these, so I think it'll be useful to have more awareness of these guidelines.


## Terms

| Use | English | Spanish | Do not use | Usage |
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This table looks accurate to me on the terms being used in Benefits. enrollment process was an interesting one to see

Good to have these surfaced up

@machikoyasuda machikoyasuda merged commit 4d5a14a into dev Dec 22, 2023
8 checks passed
@machikoyasuda machikoyasuda deleted the docs/1653-copy branch December 22, 2023 05:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation [auto] Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add docs page describing the Copy Style Guide
2 participants