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.

Sign up for GitHub

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

Jump to bottom

Docs: Copy terms & style guide #1832

Merged
merged 1 commit into from
Dec 22, 2023
Merged

Docs: Copy terms & style guide #1832

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions docs/product-and-design/.pages
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,5 @@ nav:
- use-cases
- analytics.md
- copy-delivery.md
- copy-style.md
- Design style guide: https://www.figma.com/proto/SeSd3LaLd6WkbEYhmtKpO3/Benefits-(IAL2-Login.gov)?node-id=4942%3A17385&scaling=scale-down&page-id=4890%3A17182
46 changes: 46 additions & 0 deletions docs/product-and-design/copy-style.md
View file
Open in desktop
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.
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

| :------------------------------------------ | :-------------------------------------- | :------------------------------------------------------------------------------------------------------------------- | :----------------------------------------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| **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) |   |
Loading