[Modeling] Document structure
Radovan Cervenka
rce@whitestein.com
Tue, 18 Feb 2003 10:14:43 +0100
This is a multi-part message in MIME format.
------=_NextPart_000_0036_01C2D736.8E4B4AA0
Content-Type: text/plain;
charset="iso-8859-1"
Content-Transfer-Encoding: quoted-printable
Hi all,
follows my proposal for the structure of documents describing particular =
modeling area, we identified at the Palermo meeting.
Note: Text placed into braces explains particular section, <xxx> will be =
replaced by a concrete name, section with ! is considered to be =
mandatory.
a.. <Title>! {name of the area}
b.. Overview! {description of the area to-be-modeled. What are the =
problems, how they are usually modeled, what modeling elements are used =
by the currently used techniques, what is the applicability during the =
development cycle of MAS, etc. - informally}
c.. Abstract Syntax! {UML diagram(s) of proposed metamodel; UML 2.0 =
metamodel can be taken as the basis}
d.. Class Descriptions! {class-by-class description of the =
metaclasses. For each class to specify:}
a.. <Name>! {name of the metaclass}
b.. Description! {textual description of the semantics}
c.. Attributes {a list of contained attribute descriptions}
d.. Associations {a list of related relationship descriptions}
e.. Constraints {a list of applicable constraints (called also =
well-formedness rules), described firstly in English then in OCL}
f.. Notation {description of the notation (concrete syntax)}
g.. Presentation options {description of alternate notation}
h.. Examples {examples of using an element}
e.. UML Profile Summary! {a section describing the UML profile}
a.. Mapping to UML Base Classes!
a.. {diagram(s) with UML base classes with stereotype =
<<metaclass>>, new metaclasses having stereotype <<stereotype>> and =
extension relationships; see UML 2.0. Superstructure for more details}
b.. Tagged Values {a table of defined tagged values with columns: =
Name, Type, On stereotype, Description}
c.. Stereotypes! {a table containing all defined stereotypes. Table =
can have the following columns: Stereotype, Notation, Base class, =
Stereotype parent, Description (incl. references to the metaclass =
descriptions)}
f.. Diagrams {a chapter describing proposed diagrams; for each diagram =
type to specify:}
a.. <Diagram name> {a name of the diagram}
b.. Description {Description of the diagram content (what elements =
are comprised) and applicability (why and when to use this diagram)}
c.. Examples {some sample diagram(s) and description of their =
semantics}
g.. References! {a list of used and/or relevant references; papers and =
Web pages as well; reference list should be structured according to =
different sources, sub-areas, etc.}
Note: all textual descriptions should be short but matter-of-fact.
I think that by such specification we should sufficiently cover the =
semantics and the notation. Furthermore, UML profile will be properly =
defined. What do you think? Comments are welcomed.
Furthermore we should share our UML models - they should be placed at =
the Web page into some protected area available for FIPA modeling =
members only. What UML CASE tool do you use? Will we try particular UML =
tool or XMI as an interchange format?
Regards,
Rado1.
PS I miss ontologies and communication (IPs and interactions) in the =
Jim's paper. These areas should be covered by AUML as well.
PPS Jim can you please send contacts to all FIPA modeling TC members?
PPPS When will be the Web page available? What will be the authoring =
possibilities for TC members (I think about something like (s)wiki)?
--
Radovan Cervenka | rce@whitestein.com
Whitestein Technologies | www.whitestein.com
Panenska 28 | SK-81103 Bratislava | Slovak Republic
Tel +421(2)5443-5502 | Fax +421(2)5443-5512
--
If you are not the intended recipient of this email,
you are not authorized to make any use of it;
please delete it and notify us by return email.
Thank you.
------=_NextPart_000_0036_01C2D736.8E4B4AA0
Content-Type: text/html;
charset="iso-8859-1"
Content-Transfer-Encoding: quoted-printable
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<HTML><HEAD>
<META http-equiv=3DContent-Type content=3D"text/html; =
charset=3Diso-8859-1">
<META content=3D"MSHTML 6.00.2800.1106" name=3DGENERATOR>
<STYLE></STYLE>
</HEAD>
<BODY>
<DIV><FONT face=3DArial size=3D2>Hi all,</FONT></DIV>
<DIV><FONT face=3DArial size=3D2></FONT> </DIV>
<DIV><FONT face=3DArial size=3D2>follows my proposal for the =
structure of=20
documents describing particular modeling area, we identified at the =
Palermo=20
meeting.</FONT></DIV>
<DIV><FONT face=3DArial size=3D2></FONT> </DIV>
<DIV><FONT face=3DArial size=3D2>Note: Text placed into braces explains =
particular=20
section, <xxx> will be replaced by a concrete name, section with ! =
is=20
considered to be mandatory.</FONT></DIV>
<DIV><FONT face=3DArial size=3D2></FONT> </DIV>
<UL>
<LI><FONT face=3DArial size=3D2><Title>! {name of the =
area}</FONT></LI>
<LI><FONT face=3DArial size=3D2>Overview! {description of the area =
to-be-modeled.=20
What are the problems, how they are usually modeled, what modeling =
elements=20
are used by the currently used techniques, what is the =
applicability=20
during the development cycle of MAS, etc. =
- informally}</FONT></LI>
<LI><FONT face=3DArial size=3D2>Abstract Syntax! {UML diagram(s) of =
proposed=20
metamodel; UML 2.0 metamodel can be taken as the basis}</FONT></LI>
<LI><FONT face=3DArial size=3D2>Class Descriptions! {class-by-class =
description of=20
the metaclasses. For each class to specify:}</FONT></LI>
<UL>
<LI><FONT face=3DArial size=3D2><Name>! {name of the=20
metaclass}</FONT></LI>
<LI><FONT face=3DArial size=3D2>Description! {textual description of =
the=20
semantics}</FONT></LI>
<LI><FONT face=3DArial size=3D2>Attributes {a list of contained =
attribute=20
descriptions}</FONT></LI>
<LI><FONT face=3DArial size=3D2>Associations {a list of related=20
relationship descriptions}</FONT></LI>
<LI><FONT face=3DArial size=3D2>Constraints {a list of applicable =
constraints=20
(called also well-formedness rules), described firstly in English =
then in=20
OCL}</FONT></LI>
<LI><FONT face=3DArial size=3D2>Notation {description of the =
notation (concrete=20
syntax)}</FONT></LI>
<LI><FONT face=3DArial size=3D2>Presentation options {description of =
alternate=20
notation}</FONT></LI>
<LI><FONT face=3DArial size=3D2>Examples {examples of using an=20
element}</FONT></LI></UL>
<LI><FONT face=3DArial size=3D2>UML Profile Summary! {a section =
describing the UML=20
profile}</FONT></LI>
<UL>
<LI><FONT face=3DArial size=3D2>Mapping to UML Base =
Classes!</FONT></LI>
<UL>
<LI><FONT face=3DArial size=3D2>{diagram(s) with UML base classes =
with=20
stereotype <<metaclass>>, new metaclasses having=20
stereotype <<stereotype>> and extension =
relationships;=20
see UML 2.0. Superstructure for more details}</FONT></LI></UL>
<LI><FONT face=3DArial size=3D2>Tagged Values {a table of defined =
tagged values=20
with columns: Name, Type, On stereotype, Description}</FONT></LI>
<LI><FONT face=3DArial size=3D2>Stereotypes! {a table containing all =
defined=20
stereotypes. Table can have the following columns: Stereotype, =
Notation,=20
Base class, Stereotype parent, Description (incl. references to the=20
metaclass descriptions)}</FONT></LI></UL>
<LI><FONT face=3DArial size=3D2>Diagrams {a chapter describing =
proposed diagrams;=20
for each diagram type to specify:}</FONT></LI>
<UL>
<LI><FONT face=3DArial size=3D2><Diagram name> {a name of the=20
diagram}</FONT></LI>
<LI><FONT face=3DArial size=3D2>Description {Description of the =
diagram content=20
(what elements are comprised) and applicability (why and when to use =
this=20
diagram)}</FONT></LI>
<LI><FONT face=3DArial size=3D2>Examples {some sample diagram(s) and =
description=20
of their semantics}</FONT></LI></UL>
<LI><FONT face=3DArial size=3D2>References! {a list of used and/or =
relevant=20
references; papers and Web pages as well; reference list should be =
structured=20
according to different sources, sub-areas, etc.}<BR></FONT></LI></UL>
<DIV><FONT face=3DArial size=3D2>Note: all textual descriptions should =
be short but=20
matter-of-fact.</FONT></DIV>
<DIV><FONT face=3DArial size=3D2></FONT> </DIV>
<DIV><FONT face=3DArial size=3D2>I think that by such specification we =
should=20
sufficiently cover the semantics and the notation. =
Furthermore, UML=20
profile will be properly defined. What do you think? Comments are=20
welcomed.</FONT></DIV>
<DIV><FONT face=3DArial size=3D2></FONT> </DIV>
<DIV><FONT face=3DArial size=3D2>Furthermore we should share =
our UML models -=20
they should be placed at the Web page into some protected area available =
for=20
FIPA modeling members only. What UML CASE tool do you use? Will we =
try=20
particular UML tool or XMI as an interchange format?</FONT></DIV>
<DIV><FONT face=3DArial size=3D2></FONT> </DIV>
<DIV><FONT face=3DArial size=3D2>Regards,</FONT></DIV>
<DIV><FONT face=3DArial size=3D2></FONT> </DIV>
<DIV><FONT face=3DArial size=3D2>Rado1.</FONT></DIV>
<DIV><FONT face=3DArial size=3D2></FONT> </DIV>
<DIV><FONT face=3DArial size=3D2><STRONG>PS</STRONG> I miss ontologies =
and=20
communication (IPs and interactions) in the Jim's paper. These areas =
should be=20
covered by AUML as well.</FONT></DIV>
<DIV><FONT face=3DArial size=3D2></FONT> </DIV>
<DIV><FONT face=3DArial size=3D2><STRONG>PPS</STRONG> Jim can you please =
send=20
contacts to all FIPA modeling TC members?</FONT></DIV>
<DIV><FONT face=3DArial size=3D2></FONT> </DIV>
<DIV><FONT face=3DArial size=3D2><STRONG>PPPS</STRONG> When will be the =
Web page=20
available? What will be the authoring possibilities for TC members =
(I think=20
about something like (s)wiki)?</FONT></DIV>
<DIV><FONT face=3DArial size=3D2></FONT> </DIV>
<DIV><FONT face=3DArial size=3D2>--<BR>Radovan Cervenka | </FONT><A=20
href=3D"mailto:rce@whitestein.com"><FONT face=3DArial=20
size=3D2>rce@whitestein.com</FONT></A><BR><FONT face=3DArial =
size=3D2>Whitestein=20
Technologies | </FONT><A href=3D"http://www.whitestein.com"><FONT =
face=3DArial=20
size=3D2>www.whitestein.com</FONT></A><BR><FONT face=3DArial =
size=3D2>Panenska 28 |=20
SK-81103 Bratislava | Slovak Republic<BR>Tel +421(2)5443-5502 | Fax=20
+421(2)5443-5512<BR>--<BR>If you are not the intended recipient of this=20
email,<BR>you are not authorized to make any use of it;<BR>please delete =
it and=20
notify us by return email.<BR>Thank you.</FONT></DIV></BODY></HTML>
------=_NextPart_000_0036_01C2D736.8E4B4AA0--