-
Notifications
You must be signed in to change notification settings - Fork 9
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
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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. | ||
|
||
## Terms | ||
|
||
| Use | English | Spanish | Do not use | Usage | | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe 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. Good to have these surfaced up |
||
| :------------------------------------------ | :-------------------------------------- | :------------------------------------------------------------------------------------------------------------------- | :----------------------------------------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------ | | ||
| **agency card** | agency card | tarjeta de agencia | Agency Card (don't capitalize both words) | | | ||
| **benefit option** | benefit option | opción de beneficio | | | | ||
| **Cal-ITP** | California Integrated Travel Project | California Integrated Travel Project (Proyecto Integrado de Viaje de California, o Cal-ITP por sus siglas en inglés) | | | | ||
| **Cal-ITP Benefits** | Cal-ITP Benefits | Cal-ITP Benefits | Do not translate Cal-ITP Benefits | | | ||
| **California Department of Transportation** | California Department of Transportation | Departamento de Transporte de California | | | | ||
| **California Department of Technology** | California Department of Technology | Departamento de Tecnología de California | | | | ||
| **connects** | connects | conecta | | | | ||
| **contactless card** | contactless card | tarjeta sin contacto | payment card, cashless, tap-to-pay, touchless | | | ||
| **enroll** | enroll | inscribirse | apply | | | ||
| **enrollment process** | enrollment process | proceso de inscripción | | | | ||
| **GitHub** | GitHub | GitHub | Github | | | ||
| **Littlepay** | Littlepay | Littlepay | LittlePay | | | ||
| **Older Adult** | Older Adult | adultos mayores | Senior | | | ||
| **public transportation** | public transportation | transporte público | | | | ||
| **reduced fare** | reduced fare | tarifa reducida | discounted | | | ||
| **Social Security number** | Social Security number | número de Seguro Social | social security number | | | ||
| **state-issued ID card** | state-issued ID card | tarjeta de identificación emitida por el estado | driver's license | | | ||
| **tap to ride** | tap to ride | toque para viajar | | | | ||
| **transit agency** | transit agency | agencia de tránsito | bus agency, light rail agency, transit authority | Refer to [Language Matters: Cal-ITP Terminology](https://docs.google.com/document/d/1ud73Qaa7k6I5l8MwlQrZd8iOo7_3shZHy_gCxfAe0eY/edit#heading=h.keo0rpgsdx29) | | ||
| **transit benefit** | transit benefit | beneficio de tránsito | discount, fare discounts, reduced-fare | "Older adult transit benefit", "Veteran transit benefit" | | ||
| **transit provider** | transit provider | proveedor de transporte | | | | ||
| **US Veteran** | US Veteran | Veterano de EE. UU. | U.S. Veteran, US veteran | Note: This currently goes against [Cal-ITP Editorial Style Guide](https://docs.google.com/document/d/1yG2jc_aMPSGc2wqvazKGgFIeV-aDDDsJIuONhUg0MOI/edit) | | ||
| **verify** | verify | verifique | | | | ||
|
||
## Style | ||
|
||
| | Rule | Examples | | | ||
| :------------------------ | :----------------------------------------------------------------------------------------------------------------------------- | :------------------------------------------------ | :-------------- | | ||
| **Capitalization** | Always sentence-case body text, headlines, questions on Help page. | Unable to confirm eligibility \| Cal-ITP Benefits | | | ||
| | In English, names of pages are capitalized. | Return Home | Previous Page | | ||
| | In Spanish, names of pages are not capitalized. | Volver al inicio | Página anterior | | ||
| | Refer to [Cal-ITP Editorial Style Guide](https://docs.google.com/document/d/1yG2jc_aMPSGc2wqvazKGgFIeV-aDDDsJIuONhUg0MOI/edit) | | | | ||
| **Images, illustrations** | Always write an alt tag, unless Design determines the visual is purely decorative and has no substantive meaning. | | | | ||
| **Links** | Never link to "here". Use a descriptive title for the page. | | | | ||
| **Tense** | For Spanish, use usted/formal case for all copy. | | | | ||
| **Numbers** | Refer to [Cal-ITP Editorial Style Guide](https://docs.google.com/document/d/1yG2jc_aMPSGc2wqvazKGgFIeV-aDDDsJIuONhUg0MOI/edit) | | | | ||
| **Spacing** | Refer to [Cal-ITP Editorial Style Guide](https://docs.google.com/document/d/1yG2jc_aMPSGc2wqvazKGgFIeV-aDDDsJIuONhUg0MOI/edit) | | | | ||
| **Punctuation** | Refer to [Cal-ITP Editorial Style Guide](https://docs.google.com/document/d/1yG2jc_aMPSGc2wqvazKGgFIeV-aDDDsJIuONhUg0MOI/edit) | | |
Oops, something went wrong.
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.
There was a problem hiding this comment.
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.