Documentation Index

Fetch the complete documentation index at: https://www.civicplus.help/llms.txt

Use this file to discover all available pages before exploring further.

Naming Conventions Best Practices

Prev Next

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

Categories should be as broad as possible. Examples include Government, Services, About Us, Visitors, and Business.

We recommend this best practice to ensure categories are broad enough to cover many topics. Broad categories are also flexible enough to support future needs and updates. If an item does not contain navigation beneath it, it is better suited for the left navigation, a graphic button, or another global navigation category. For example, if "Council" is a global navigation category, it limits the type of information users expect to find there. The broader label "Government" allows you to group 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.