OASIS Mailing List ArchivesView the OASIS mailing list archive below
or browse/search using MarkMail.


Help: OASIS Mailing Lists Help | MarkMail Help

soa-rm-ra message

[Date Prev] | [Thread Prev] | [Thread Next] | [Date Next] -- [Date Index] | [Thread Index] | [List Home]

Subject: Re: [soa-rm-ra] editing convention

I think that a class that we introduce in a model is exactly a concept that we are defining.

On Aug 27, 2008, at 2:28 PM, Ken Laskey wrote:

How do we style classes in our models?  For example, when we introduce "resource", do we have, for example, Resource (or bold or italics or ...) and then would we keep that style when referring to class vs. use where not the specific class in the model?


On Aug 27, 2008, at 4:43 PM, Francis McCabe wrote:

I agree.

I humbly suggest the definitional style and referencing style for all defined concepts:

   A term is a term of common usage.

Some comments about term may be useful here.


P.S. I am aware that a fair amount of word work will be needed to get to this style.

On Aug 27, 2008, at 1:39 PM, Jeffrey A. Estefan wrote:

My vote is to be consistent with the convention we used in the RM, which, if I remember correctly, was to use bold on first instance of a concept and lower case in future instances.
That said, I also noticed we are not consistent in how we define terms.  In some cases we re-state the term followed by text definition.  In other cases, we just provide the text definition and not re-state the term.  For example, for View in Section 1 (and other related concepts), we show View in bold text and on the definition line, we state "A representation of the whole system...".  Whereas, in Section 3, we define terms like Agent by showing the Agent in bold text and on the definition line, we state "An agent is ...".  Again, we should adopt a convention and use it consistently throughout the RA.
 - Jeff

Ken Laskey
MITRE Corporation, M/S H305      phone: 703-983-7934
7515 Colshire Drive                         fax:       703-983-1379
McLean VA 22102-7508


[Date Prev] | [Thread Prev] | [Thread Next] | [Date Next] -- [Date Index] | [Thread Index] | [List Home]