Introduction to naming conventions
Naming convention is about giving names in a specific manner that enables the user to understand and manage resources better. By working with a standardized and agreed upon naming convention, the organization can have improved communication, undertake easier management and have a quicker understanding of the resources. As Frends requires the developers and users to name the resources, it is crucial to have a consistent naming convention in place.
In the context of Frends, for instance, users need to define names for the following resources to fulfil basic use cases:
Processes and Subprocesses
APIs
Resources and methods
API Keys and API Rulesets
API Access Policies
Elements in Processes and Subprocesses
Tasks
Decisions
Loops
Scopes
Custom code
Variables, classes, functions
Variables
Variables in Processes
Environment Variables
Variables in custom code
Roles
Monitoring Rules
In general, the names should be:
Alphabetic and numerical characters only
Short, meaningful, descriptive and pronounceable
Searchable
In the end, the key to naming conventions is consistency and commonly agreed guidelines.
The following modules introduce the most common best practices for naming conventions in Frends.
The next article is Best practices on Naming Processes and Subprocesses