Naming Conventions

Consistent naming conventions is a key point in delivering professional tours. Using a logical and consistent naming convention helps people to remember and “generate” the correct urls when for searching for a particular tour.

Rules

  1. Use hyphenated words over underscores.
    • Reasoning: “_” requires pressing the shift key which makes it more difficult to type the url. Standard web practice and SEO optimizations also dictate using “-“ over “_”.
  2. Use all lowercase.
    • Reasoning: While in theory urls are case agnostic, buggy code can sometimes cause issues. By using lowercase as a standard naming convention, we can avoid issues of broken links due to case sensitive code.
  3. Use C1 Postal Service Standard Suffix abbreviations.
    • Reasoning: Where possible, use established conventions. It makes it easier to remember because people have less things to remember.
  4. If applicable, designate units/apts. Use C2 Postal Service Standard Suffix abbreviations.
    • Reasoning: Where possible, use established conventions. It makes it easier to remember because people have less things to remember.
  5. If applicable, prefix with managment company/realtor abbreviation.
    • Reasoning: Customers love slapping their brand on something. It makes it more personal if they can show that defines it as “theirs”.
    • NOTE (atu): It is possible that we will produce multiple URLs pointed to the same tour. For example, a projects true url may be address.netlify.app.com and we would produce seeboston360.com/address AND seeboston360.com/bbg-address.

Examples

Ordinary Street Address

  • 92 Hammond St, Apt 4 → 92-hammond-st-apt-4

Street Address from associated to Boston Brokerage Group (bbg)

  • Boston Brokerage Group: 92 Hammond St, Apt 4 → bbg-92-hammond-st-apt-4