Wednesday, September 7, 2011

Ten Rules for Naming Operational Activities & System Functions


Operational Activities and System Functions (and the activity models, process models, function models, functional or process flows, sequence diagrams, or activity/function “threads” of which they are a part) are essential components of any Enterprise Architecture.  They effectively identify what the enterprise is all about—what the enterprise does; who or what does it; how it does it; with what it is done; and for or to whom or what it is done.  Naming these activities and functions provides a reader with a critical understanding of the purpose, scope, and point of view of not just the model of which they are a part, but also of the parent architecture as a whole.  Enterprise Architects must carefully consider the names assigned to enterprise operational activities and systems functions, taking into account their importance in facilitating understanding of the enterprise as a whole.  With this in mind, the following ten rules for naming operational activities and system functions are presented for consideration and use by modelers and architects.


  1. Be concise: The name chosen for an activity or function should be long enough to give one a good understanding of what the activity or function is about, but not so long as to read as a description instead of a title.  As a general rule, if the name has more than about six words, you probably should consider shortening it.  Save the details for inclusion in the activity or function description.
 

  1. Be singular: An activity or function, and its name, should describe a single action, process, or behavior.  Though it may sometimes be necessary to combine two activities or functions into one in order to meet some modeling rules, the resulting composite activity or function should be assigned a singular name.     One method for doing this is to select a generic term phrase that encompasses the original two terms or phrases.  For example, replace “Bake a Cake and Roast a Turkey” with “Cook Food”; replace “Wash and Wax Car” with “Detail Car”, etc.


  1. Use approved terminology or terminology familiar to the community: If the activity or functional model is being developed for an enterprise, system, organization, or functional area for which an approved, standardized vocabulary exists, then the activity or function name should be selected from that standardized vocabulary if possible.  Even if no approved community vocabulary exists, the name chosen for an activity or function should use terminology that is familiar to and understandable by personnel within the community.
 

  1. Avoid using abbreviations and acronyms: Abbreviations and acronyms can significantly shorten an activity or function name, but they can also make them less understandable. For abbreviations, especially, they can have more than one meaning.  For example, the abbreviation “C.A.P.” can stand for either “Civil Air Patrol” or “Combat Air Patrol”.  This can lead to confusion over the correct meaning, or misinterpretation when the wrong meaning is assumed.  So unless the meaning is so universally recognized, or so clear from the context as to preclude misinterpretation, abbreviations and acronyms should be fully expanded or replaced with equivalent terms.
 

  1. Follow existing naming conventions and standards: For communities that have adopted activity and/or function naming conventions, activity and function names should be selected in accordance with those conventions.  There may even exist communities that have adopted both a standard vocabulary (see rule 3 above) and a set of activity and function naming conventions.  Within these communities, activity and function names should be selected to be consistent with both.


  1. Be descriptive of the process covered, or of the output of the process:  Even though the activity or process should have a detailed definition that fully describes it, the name should present to the reader an indication of what the activity or function is about.  [See rules 7, 8, and 9 below for further details on writing descriptive titles.]


  1. Use a verb phrase to identify the action, process, or behavior addressed: Probably the most important part of selecting a name for an activity or function is determining the right verb or verb phrase to capture the nature of the action, process, or behavior encompassed by the activity or function.  Ideally, the verb should be active and in the present tense.
 

  1. Use a noun to identify the object of the action, process, or behavior:  After selecting the proper verb or verb phrase to define the behavior, probably the next most important aspect of naming the activity or function is choosing an appropriate noun or set of nouns to identify the object of the action, process or behavior.  Without a noun to define what is being affected, the true nature of an activity or function nearly impossible to determine.  For example, an activity with the name “Generate” could mean almost anything—Generate Electricity, Generate Profits, even Generate Thought.  But the correct noun or set of nouns eliminates the ambiguity, making the meaning of the activity or function crystal clear (e.g., Generate Simulated Speech).
 

  1. Use adverbs and adjectives to distinguish similar processes:  Having chosen the perfect verb and noun pair is often all that is needed to create an effective name for an activity or function.  Sometimes; however, is may be necessary to use adverbs or adjectives to modify the verbs or nouns to make the activity or function name more specific or more accurate.  For example, it may require a slightly different process and set of resources to wash a large vehicle than it does to wash a small one.  So adjectives may be used to create separate activities named “Wash Large Cars” and “Wash Small Cars”.  Likewise, there may be alternative ways to perform the same process that need to be accounted for in the activity or function name.  So adverbs may be used to produce separate activities such as “Manually Process Insurance Claims” and “Automatically Process Insurance Claims”.
 

  1. Be consistent throughout the model:  The final recommendation for naming activities and functions is to be consistent throughout the model.  This means not only using consistent naming conventions, but also presenting a consistent level of detail in activity or function names.  Names in one part of the model should not be short and concise while those in other parts are long and verbose.  Consistent naming conventions, consistent levels of detail, and consistent use of modifiers in activity and function names makes the model much easier for a reader to understand.

No comments: