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

Update UGRC style sheet #2763

Open
steveoh opened this issue May 30, 2024 · 13 comments
Open

Update UGRC style sheet #2763

steveoh opened this issue May 30, 2024 · 13 comments

Comments

@steveoh
Copy link
Member

steveoh commented May 30, 2024

The current UGRC style sheet needs to be updated and be more visible. Our policy and procedure pillar is a good fit.

We need to come to identify and come to consensus on spelling, capitalization, etc of common terms and phrases on our website.

e.g.

  1. LiDAR ZIP Code webmap base map
  2. table feature class feature layer
  3. attribute field column
@steveoh steveoh changed the title migrate pdf stylesheet to html Update UGRC style sheet May 30, 2024
@gregbunce
Copy link
Contributor

gregbunce commented May 30, 2024

what are base maps? (just kidding, ignore this)

@gregbunce
Copy link
Contributor

most folks use ZIP Code

@gregbunce
Copy link
Contributor

I vote for lidar

@steveoh
Copy link
Member Author

steveoh commented May 30, 2024

most folks use ZIP Code

can we use that if it's trademarked? 🤪

Merriam Webster and chicago unsurprisingly don't agree with your opinion.

Let's plan on a meeting, ideally including @miriamseely, to identify the common items and then we can rock paper scissor or kick box to pick one.

I vote for lidar

I think Rick already chose a spelling but we haven't documented it yet.

@miriamseely
Copy link
Collaborator

I agree a meeting would be good! I have an odd schedule but can generally meet weekdays 4:30pm onward, is there a time there that works for everyone? If I'm not able to attend, I can certainly work with the style guide document to implement the correct language in the metadata.

@gregbunce
Copy link
Contributor

4:30 works for me. Can we look at a date sometime after June 10?

@miriamseely
Copy link
Collaborator

How does this Wednesday (6/19) at 4:30 sound?

@steveoh
Copy link
Member Author

steveoh commented Jun 18, 2024

I might be a bit late but i can make it.

@gregbunce
Copy link
Contributor

could we bump this to either Thursday the 20th, Monday the 24th or Tuesday the 25th?

@miriamseely
Copy link
Collaborator

Monday 6/24 or Tuesday 6/25 both work for me!

@miriamseely
Copy link
Collaborator

General Style Guide Notes

  • Avoid using “here” and “this” links. Say “you can read more about this on our blog” not “you can read more about this here.”
  • Rather than “six months” we say semi-annually
  • Capitalize “State” when referring to the political entity, and use lowercase “state” when referring to the geographical location
  • Base map not basemap
  • Spell out numbers one through ten
  • Always use the Oxford comma
  • Use "whether" if there are only two possible options. Use "if" in cases where you don't know how many options there are.
  • Active voice instead of passive voice
  • Tone should be: interesting, approachable, and entertaining
  • Items in a bullet point list should all end in a period, or none of them should end in a period. Don’t have a mix of complete and incomplete sentences in a list (either they are all complete, or none of them are)
  • Data are plural, but dataset is singular
  • File names are always lowercase and words are separated by underscores or hyphens
  • Refer to GIS line data as polyline data
  • Spell out the acronym the first time it appears on a page, and then use the acronym after that

Abbreviations and Acronyms

  • All acronyms are used in text without periods to separate letters. For example, “United States Census Bureau”, when abbreviated, is written as “US Census Bureau”. Other examples include “USFS” or “SGID”.
  • Dates are abbreviated as Month 1, 2020. For example it would be “January 1, 2020” not “January 1st, 2020”.
  • Esri not ESRI
  • Lidar not LiDAR or LIDAR
  • ZIP code not Zip Code
  • e.g. means "for example" and i.e. means "in other words"

Questions

  • Et cetera, etc., or etc?
  • Try to keep lists in paragraph form (This layer includes a, b, c, and d) or in bullet point form?
  • Do we use second person? “You can read more about this on our website” versus “More information can be found on our website”.
  • Capitalize GIS tools such as Dissolve or Join, or keep them lowercase?
  • Use contractions “don’t” and “aren’t” or separate words “do not” and “are not”?

@steveoh
Copy link
Member Author

steveoh commented Jun 26, 2024

Use contractions “don’t” and “aren’t” or separate words “do not” and “are not”?

If I remember correctly, the DGO style guide recommends contractions.

@steveoh
Copy link
Member Author

steveoh commented Jul 18, 2024

here are my notes from viewing the two style guides...

https://steve-gourley.notion.site/Writing-guide-77747c66b4ee43c18f63fa4624313879

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants