Wikipedia has one of the best definitions on the net for a "naming convention": A naming convention is a convention for naming things. Awesome!- Make the name descriptive
- Use abbreviations to identify object type
- Begin object name with its object type abbreviation
For example, a credit rule could be called CR_AE_description. Some systems could have a direct credit rule and an indirect credit rule; in such case my abbreviation could be DC and IC instead. In some systems I may want to prefix a formula with F (if all objects can be displayed in the same view), if not, then it would not be necessary to explicitly say that a formula is a formula.
Naming of output is also important: The importance of naming an object may be obvious, but in the case of rules, the output of such rule should also be named carefully. A result name that makes sense can often by "Rule name _ result" or something similar.
Getting Started...
It is important to define a naming strategy early on in the project - before any detailed / technical design documents are created. The strategy should be illustrated on one page to enable the implementers to quickly see how to name the different objects. This "page" should be distributed to everyone involved in the implementation and be given to new joiners as well.
The first steps in defining the naming strategy is to find out if the application being used has a set of best naming practices or standards. In the case of an upgrade, it is important to stick to previously used naming strategy.
Happy Naming!
No comments:
Post a Comment