Name content objects

A structured naming convention lets you locate and edit the objects you need quickly, and it speeds up building pages and other content.

Here are some recommended conventions. You may already have others in mind for your business.

Page names

[Store]-[Page name]

NY - Partner list

Including a store name, location, or other changeable identifier makes the page easy to identify, and helps future-proof it through a redesign.

Content block names

Content blocks might be unique to a page, or may be reused across your site.

Unique:

[Store] - [Parent/Child] - [page] - [block]

NY - P - Partner list - Top Hero

Re-usable:

[Store] - [Parent/Child] - [usage] - [block]

NY - P - Common - Footer

Media file names

Media files can be tricky to name using a convention as there can be many of them, and they may all end up with very long names.

Store - Page/Product Category - Name - Variant

Guiding principles of naming files

• Consistency — use one standardized format for every file in a project, so they are identifiable and sortable.
• Descriptive, concise names — include the identifiers that describe the content without opening the file, such as page name and store.
• Structure for sorting — put dates and numerals in a sortable form, such as YYYYMMDD or YYYY-MM-DD.

• No special characters — avoid ~ ! @ # $ % ^ * ( ) ; : ? , [ ] { } ‘ “

  \ /

• Separators — use underscores or hyphens between elements rather than spaces.