Skip to main content

Search

We are excited to announce the launch of updated product names, logos, and headers within our user interfaces as part of the CivicPlus® Solution Rebranding initiative. These changes mark the first step toward creating a cohesive and seamless user experience across all solutions in our portfolio. As part of this transition, users may notice minor design updates. While the functionality you rely on remains unchanged, we are in the process of updating screenshots and other resources on our Help Centers to reflect the new branding. We appreciate your patience and understanding as we work to complete these updates.

Naming Conventions Best Practices

  • Updated:

File Name Conventions

  • Intuitive Names: File names should be intuitive
    • Keep the names intuitive and simple to allow a user to easily search and find any documentation on the website.
  • Simple File Names: File names should only contain letters, numbers, and the underscore (_) if space is needed
    • Spaces and special characters cannot be read by all software. To avoid conflicts, it is best to always use a simple file name that does not include any spaces or special characters.
  • Short File Names: File names should not exceed 25 characters
    • Most fields in modules that accept documents have a character size limit to ensure optimal functionality. Keep the file names under 25 characters to make them compatible with any module.

 

Global Name Conventions

Global navigation categories should be as broad and overarching as possible such as government, services, about us, visitors, or business.

  • We recommend this best practice to ensure the categories are broad enough to encompass many topics and be flexible enough to accommodate future needs and updates; if an item does not house navigation below it, it is better suited for the left navigation, graphic button, or under another global. For example, if "Council" is a global navigation category, it limits the type of information users will expect to find under it. The broader label "Government" allows for the grouping of similar types of information.

 

Page Name Conventions

Pages, files, and links should have names that are intuitive, simple, and concise.

  • Intuitive and simple names will limit any user from misunderstanding the purpose of a global navigation item.
  • Resource: Avoid Category Names That Suck by Hoa Loranger with the Nielsen Norman Group

Comments

Let us know what was helpful or not helpful about the article.

0 comments

Please sign in to leave a comment.