department-of-veterans-affairs / vets-design-system-documentation

Repository for design.va.gov website
https://design.va.gov
40 stars 61 forks source link

Update DS Documentation to use Sketch Naming Conventions best practices for all Sketch files #1666

Closed josephrlee closed 2 weeks ago

josephrlee commented 1 year ago

Duplicate check

This update is for:

Update documentation

What is the name?

About/Naming and About/Designers/Sketch for Teams

What is the nature of this update?

What problem does this solve?

Add a section to the Naming Convention documentation and the Sketch for Teams page in the About Section for working inside of Sketch specifically. Also, update the Getting Started artboard in the Sketch for Teams Template.

Allows for standardized naming conventions for designers to follow when creating Sketch files specifically for Page, Artboard, and Group names since these are not already defined in the Design System. It will help designers working on the same files to keep things consistent and more readable.

Use these rules defined by the Sketch Assistant:

Additional Context

No response

caw310 commented 1 year ago

@josephrlee , Would you be able to attend the Design System Council meeting on Friday, April 7 at 1pm to talk about this request? It would be helpful if you could speak to this with the group.

humancompanion-usds commented 1 year ago

@josephrlee - Having some consistency with page names and artboard names makes sense to me. Symbol names are already standardized via the Design System component library. How folks names their groups and symbols seems a bit pedantic. What are the goals here or the problems this would solve?

josephrlee commented 1 year ago

Thanks for following up @humancompanion-usds. As a newish designer on the team and the org, I think it'd allow folks like me to be able to read and digest the files faster especially when looking at other projects' files to see how other teams are approaching problems. If the Group/Symbol naming is too pedantic, then at least the page naming consistency would be helpful to have. Thanks!

caw310 commented 2 weeks ago

Closing as we have migrated to Figma so this should have been addressed. Write a new ticket if this is an issue in Figma.