Skip to main content

How Should Defined Terms Be Formatted in Definitions?

An enterprise may go to a lot of trouble to develop definitions.  Some degree of standardization across these definitions is helpful.  One aspect of standardization is dealing with terms that appear in definitions.  Terms can be divided into two classes: Common Terms, which widely understood, and require no definition; and Defined Terms, which signify the concepts that the enterprise is defining.

A major rule in definitions is that the term signifying the concept should not appear in the definition.  This is a good idea for summary definitions, but it is hard to justify in full definitions.  Thus, if one component of a definition is a summary, it is best to keep the term being defined out of the summary.  However, the term should be allowed elsewhere in the definition.

Common terms should be allowed in a definition with no special formatting.  There is no need to distinguish them as something special.  Indeed, this would be misleading.  

Defined Terms (either the term being defined, or terms defined elsewhere by the enterprise) should be distinguished.  One reason is that terms composed of many words may not easily be understood to form a single term.  E.g. "The project code management team should be contacted".  Perhaps this refers to a team that manages project codes ("Project Code management team") or perhaps it is a team that manages code for a project ("project Code Management team").  A common way to distinguish Defined Terms is to capitalize them.  This makes it easier for the reader to understand they are a defined term (versus common term), and also to understand that a series of words forms one term.  Another approach is to make defined terms bold.  However, this tends to indicate emphasis rather than the presence of a defined term, and may be disagreeable to readers.  Underlining and italics are also used to indicate emphasis, but may sometimes be a convention for defined terms, as in biological species names, e.g. Panthera leo.

Defined Terms can also be turned into hyperlinks in definition repositories.  This clearly distinguishes them.  Usually this is an automated feature, so Common Terms can get hyperlinked too if they are included in the repository.  Therefore governance is required to keep Common Terms out of the repository.

Comments

Popular Posts

Create Your Own Social Networking Site

Create Your Own Social Networking Site JCOW: Ethical Hacking Top 10 reasons to choose Jcow:- 1. Handle more traffic - Clean codes and Dynamic caching can lower the CPU load and  speed up your website. 2 Make your site more interactive - Well designed Jcow applications help you members to connect and communicate with others more effectively. 3 Add questions to the Registration Form - You can add new member fields, which will be displayed to the registration form, profile form, and the member browsing form. 4 Easily share stuff - Within the AJAX sharing Box, your members can publish status,  photos, videos, and blogs. 5 Customize and Extend your Jcow Network - A Jcow network consists of core apps(like "Friends" and "Messages") and optional apps(like "Blogs" and ""Videos"). You can enable/disable optional apps. You can also develop your own apps. 6 Every profile could be Unique - Members can customize their own profile theme and  add music play...

WRITE "I LOVE YOU" ON CMD BY USING NOTEPAD

I had previously posted about   Matrix effect   using Notepad   as well as cool batch file  programs. In this post i will share with you guys  the cool and awesome  Notepad Tricks .  As name suggest you don't require any program other then Notepad.  So lets get started. 1. Open  Notepad   and copy below code. @echo off color 0A :A echo IIIIIII     L      OOOOOO V           V  EEEEEE     Y       Y  OOOOOO  U     U  ping -a .9 >nul echo    I        L      O    O  V         V   E           Y     Y   O    O  U     U  ping -b .9 >nul  echo    I        L      O    O   V       V    E   ...

HL7V2.x to HL7V3.0 Translation Issues Details-2

In continuation of my previous post this post lists the other issues associated with HL7 v2.x to HL7v3 translation Conformance Patterns: The other major issue with the transformation of messages is the behavior of application when a particular information exchange takes place. In HL7V3.0 apart from the trigger events and interactions there exists the notion of application role as senders and receivers. The application role is characterized as the entire set of interactions for which the sender and receiver are responsible for transmitting. HL7V3.0 clearly defines the possible interactions and the application behavior associated these interactions in the form of responses for which the sender and receiver needs to adhere to. The differences in messages between V2.x and V3.0 and absence of clear guidance on V2.x regarding application behavior on receipt of message makes the transformation exercise more difficult. Vocabulary: It is a well known fact that 80% of HL7 V2.x message failu...