Login | Register
My pages Projects Community openCollabNet

Discussions > cvs > CVS update: /reqs/www/rml/, /reqs/www/

reqs
Discussion topic

Back to topic list

CVS update: /reqs/www/rml/, /reqs/www/

Reply

Author bannerman
Full name Steve Bannerman
Date 2004-03-18 13:44:36 PST
Message User: bannerman
Date: 04/03/18 13:44:36

Added:
 /reqs/www/rml/
  index.html

Modified:
 /reqs/www/
  index.html

Log:
 

File Changes:

Directory: /reqs/www/rml/
=========================

File [added]: index.html
Url: http://reqs.tigris.o​rg/source/browse/req​s/www/rml/index.html​?rev=1.1&content​-type=text/vnd.viewc​vs-markup
Added lines: 105
----------------
<html>
<head>
 <style type="text/css">
/* <![CDATA[ */
@import "http://www.tigris.or​g/branding/css/tigri​s.css";
@import "http://www.tigris.or​g/branding/css/inst.​css";
/* ]]> */
 </style>
  <link rel="stylesheet" type="text/css" href="http://www.tigris.or​g/branding/css/print​.css" media="print" />
<script src="http://www.tigris.or​g/branding/scripts/t​igris.js" type="text/javascript">
</script>
 <title>The Requirements Markup Language</title>
</head>
<body>

<h3>The Language</h3>

            <P>There is nothing complicated about RML - we hope.&nbsp; It is an
            Extensible Markup Language that allows for a description, a set of
            attributes, and a set of associations.&nbsp; That's it!&nbsp; Here
            is an example:</P>

            <font FACE="Courier" SIZE="1">
            <p ALIGN="left" style="line-height: 100%; word-spacing: 0; margin-top: 0; margin-bottom: 0">&lt;requir​ement&gt;</p​>
            <p ALIGN="left" style="line-height: 100%; word-spacing: 0; margin-top: 0; margin-bottom: 0">&nbsp;
            &lt;description​&gt;Create a switch in the context of a
            site&lt;/descrip​tion&gt;</p​>
            <p ALIGN="left" style="line-height: 100%; word-spacing: 0; margin-top: 0; margin-bottom: 0">&nbsp;
            &lt;attributes​&gt;</p>
            <p ALIGN="left" style="line-height: 100%; word-spacing: 0; margin-top: 0; margin-bottom: 0">&nbsp;​&nbsp;&nbsp;
            &lt;attribute type=&quot;string&quot; name=&quot;owner&quot;
            value=&quot;John Smith&quot;&​gt;&lt;/attribut​e&gt;</p>
            <p ALIGN="left" style="line-height: 100%; word-spacing: 0; margin-top: 0; margin-bottom: 0">&nbsp;​&nbsp;&nbsp;
            &lt;attribute type=&quot;date&quot; name=&quot;creat​ed&quot;
            value=&quot;01/0​1/2003&quot;​&gt;&lt;/attribu​te&gt;</p>​
            <p ALIGN="left" style="line-height: 100%; word-spacing: 0; margin-top: 0; margin-bottom: 0">&nbsp;
            &lt;/attributes​&gt;</p>
            <p ALIGN="left" style="line-height: 100%; word-spacing: 0; margin-top: 0; margin-bottom: 0">&nbsp;
            &lt;associations​&gt;</p>
            <p ALIGN="left" style="line-height: 100%; word-spacing: 0; margin-top: 0; margin-bottom: 0">&nbsp;​&nbsp;&nbsp;
            &lt;association type=&quot;url&quot; name=&quot;defect A123
            case&quot; value=&quot;http://bugzilla-serv​er/defects/A123</​a>&quot;&​gt;&lt;/associat​ion&gt;</p​>
            <p ALIGN="left" style="line-height: 100%; word-spacing: 0; margin-top: 0; margin-bottom: 0">&nbsp;​&nbsp;&nbsp;
            &lt;association type=&quot;relat​ive&quot; name=&quot;refining use
            case&quot; value=&quot;file​1&quot;&gt;​&lt;/association​&gt;</p>
            <p ALIGN="left" style="line-height: 100%; word-spacing: 0; margin-top: 0; margin-bottom: 0">&nbsp;​&nbsp;&nbsp;
            &lt;association type=&quot;absol​ute&quot; name=&quot;related test
            case&quot; value=&quot;file​2&quot;&gt;​&lt;/association​&gt;</p>
            <p ALIGN="left" style="line-height: 100%; word-spacing: 0; margin-top: 0; margin-bottom: 0">&nbsp;
            &lt;/association​s&gt;</p>
            <p ALIGN="left" style="line-height: 100%; word-spacing: 0; margin-top: 0; margin-bottom: 0">&lt;/requi​rement&gt;</p​>
            </font>

            

<h3>The Language Elements</h3>

            <P>At their simplest, requirements are a descriptive statement -
            therefore a description element. But, for whatever reason, requirements
            may not have a description throughout their entire lifecycle. Thus,
            the description is optional.</P>
            <P>In different contexts,
            requirements may or may not have a set of attributes associated with
            them; therefore, attributes are optional.&nbsp; Similarly,
            associations to other artifacts are optional.&nbsp; For a more
            formal description of RML, check out the Document Type Description (<a href="rml.dtd">DT​D</a>).&nb​sp;</P>
            
<h3>Why so General?</h3>

            <P>The reason that we don't try to constrain the language any further is that
            we realize that every project is different. Each project has its own requirements
            dialect, whether they know it or not. Hopefully this language is generic enough
            to support all of the dialects and not so general that it's useless.</P>

<h3>Why Requirements Files?</h3>

            <P>By separating requirements out into individual RML files, we
            avoid the &quot;monolithic&quot; requirements document that we all
            fear.&nbsp; We no longer need to concern outselves with the format
            of a requirements document; rather, we focus our efforts on the
            contents of the requirements themselves. We should be able to
            generate a requirements document, if we need one, by using related
            technologies (such as XSL/XSLT)</P>
            
            <P>For a more in-depth discussion on why and when we should manage requirements
            in a file-based architecture, as opposed to ultra-lightweight, lightweight,
            or heavyweight architectures, read this <a href="../pdfs/mrmf.p​df">paper</a​>.</P>
            
<h3>What's next?</h3>

            <P>For some, describing requirements in a dialect of this language might
            be useful and sufficient. If they need a really lightweight mechanism
            for managing their requirements, and all of the team members are comfortable
            reading and writing in this language, this might be suitable in and of itself.
            </P>
            
            <P>However, XML instances such as RML are not necessarily easy to
            read and write.&nbsp; Therefore, we could use some tools to help us read,
            write, sort, filter, and transform them.&nbsp; That's another goal of this
            project - check out the products aimed to provide this support
            <a href="../products/in​dex.html">here​</a>.</P>


</body>
</html>

Directory: /reqs/www/
=====================

File [changed]: index.html
Url: http://reqs.tigris.o​rg/source/browse/req​s/www/index.html?r1=​1.5&r2=1.6
Delta lines: +2 -2
-------------------
--- index.html 17 Mar 2004 07:51:27 -0000 1.5
+++ index.html 18 Mar 2004 21:44:33 -0000 1.6
@@ -58,8 +58,8 @@
 
 <ul>
 
- <li> we will use requirements markup language (RML) for embodying requirements dialects
- of all "shapes and sizes."</li>
+ <li> we will use requirements markup language (<a href="rml/index.html​">RML</a>) for embodying requirements
+ dialects of all "shapes and sizes."</li>
     
     <li> we will develop the tools for manipulating requirements in Java (at least for now).</li>
     




--------------------​--------------------​--------------------​---------
To unsubscribe, e-mail: cvs-unsubscribe at reqs dot tigris dot org
For additional commands, e-mail: cvs-help at reqs dot tigris dot org

« Previous message in topic | 1 of 1 | Next message in topic »

Messages

Show all messages in topic

CVS update: /reqs/www/rml/, /reqs/www/ bannerman Steve Bannerman 2004-03-18 13:44:36 PST
Messages per page: