blob: 67365331a3d441105dd7ae9319643c85eabe1caa [file] [log] [blame]
<?xml version="1.0" encoding="UTF-8"?>
<org.eclipse.epf.uma:ContentDescription xmi:version="2.0" xmlns:xmi="http://www.omg.org/XMI" xmlns:org.eclipse.epf.uma="http://www.eclipse.org/epf/uma/1.0.3/uma.ecore" rmc:version="7.1.0" epf:version="1.0.0" xmi:id="-AJQLv2ldVv5KN9eUbdQe_g" name="new_guideline,_6jXzYNcKEdqz_d2XWoVt6Q" guid="-AJQLv2ldVv5KN9eUbdQe_g" changeDate="2006-05-01T15:33:21.329-0700" version="1.0.0">
<mainDescription>&lt;P&gt;To write a good requirement,
you must write it&lt;strong&gt; &lt;/strong&gt;as a complete sentence, with a subject
and a predicate (usually a verb). The subject&amp;nbsp;is
an Actor, a stakeholder, the system under development, or a design entity that
is related to the requirement. The predicate specifies a condition, action,
or intended result that is done for, by, with, or to the subject.&lt;/P&gt;
&lt;P&gt;Consistent use of the verb &lt;strong&gt;to be &lt;/strong&gt;solidifies
the link between the subject and the predicate.&lt;strong&gt;
&lt;/strong&gt;Thus, you can analyze a requirement from
a grammatical point of view. &lt;/P&gt;
&lt;P&gt;Beware of lists, bullets, and words such as &lt;strong&gt;all&lt;/strong&gt;, &lt;strong&gt;every&lt;/strong&gt;and &lt;strong&gt;some&lt;/strong&gt;. For example:&lt;strong&gt; &lt;/strong&gt;&lt;/P&gt;
&lt;blockquote&gt;
&lt;p&gt;The order entry clerk must&lt;strong&gt; &lt;/strong&gt;be
able to complete 10 customer orders in less than two hours.&lt;/p&gt;
&lt;/blockquote&gt;
&lt;P&gt;This requirement has a subject (the order entry clerk, who&lt;strong&gt;
&lt;/strong&gt;is an Actor), a specific and measurable
end state (10 customer orders completed), and a performance criterion
(in less than two hours).&lt;/P&gt;
&lt;P&gt;Follow these simple guidelines&lt;strong&gt; &lt;/strong&gt;
in writing any requirement. For consistency, these examples
are all in the context of an aircraft. [[WAS: is used throughout.]] &lt;a class=elementlinkwithusertext href=&quot;./../../../openup_basic/guidances/supportingmaterials/references,_9ToeIB83Edqsvps02rpOOg.html&quot; guid=&quot;_9ToeIB83Edqsvps02rpOOg&quot;&gt;[TEL06]&lt;/a&gt;
&lt;/P&gt;
&lt;ul&gt;
&lt;li&gt;Define one requirement at a time.
&lt;blockquote&gt;
&lt;p&gt;The pilot shall be able to control the aircraft's angle of climb with
one hand.&lt;/p&gt;
&lt;/blockquote&gt;
&lt;/li&gt;
&lt;/ul&gt;
&lt;blockquote&gt;
&lt;blockquote&gt;
&lt;p&gt; The pilot shall be able to feel the angle of climb from the climb control.&lt;/p&gt;
&lt;/blockquote&gt;
&lt;/blockquote&gt;
&lt;ul&gt;
&lt;li&gt;Avoid conjunctions (and, or) that make multiple requirements. &lt;/li&gt;
&lt;/ul&gt;
&lt;blockquote&gt;
&lt;blockquote&gt;
&lt;p&gt;The navigator shall be able to view the aircraft's position relative to
the route's radio beacons. &lt;/p&gt;
&lt;p&gt;The navigator shall be able to view the aircraft's position as
estimated by inertial guidance.&lt;/p&gt;
&lt;/blockquote&gt;
&lt;/blockquote&gt;
&lt;ul&gt;
&lt;li&gt;Avoid let-out clauses or words that imply options
or exceptions (unless, except, if necessary, but). &lt;/li&gt;
&lt;blockquote&gt;
&lt;p&gt;The design shall provide a rear-facing seat
for each cabin crew member.&lt;/p&gt;
&lt;/blockquote&gt;
&lt;li&gt;Use simple, direct sentences. &lt;/li&gt;
&lt;/ul&gt;
&lt;ul&gt;
&lt;blockquote&gt;
&lt;p&gt;The pilot shall be able to see&lt;strong&gt; &lt;/strong&gt;the
airspeed indicator.&lt;/p&gt;
&lt;/blockquote&gt;
&lt;li&gt;Use a limited (500-word) vocabulary, especially if your audience is international.
&lt;blockquote&gt;
&lt;p&gt;The airline shall be able to convert the
aircraft from business to holiday charter use in less than 12 hours &lt;/p&gt;
&lt;/blockquote&gt;
&lt;/li&gt;
&lt;blockquote&gt;
&lt;p&gt;&lt;strong&gt;Note: &lt;/strong&gt;There is no need to use words such
as &lt;strong&gt; reconfigured. &lt;/strong&gt;&lt;/p&gt;
&lt;/blockquote&gt;
&lt;li&gt;Identify the type of user who needs each requirement.
&lt;/li&gt;
&lt;/ul&gt;
&lt;ul&gt;
&lt;blockquote&gt;
&lt;p&gt;The navigator shall be able to...&lt;/p&gt;
&lt;/blockquote&gt;
&lt;li&gt;Focus on stating what result you will provide&lt;strong&gt;
&lt;/strong&gt; for that type of user. &lt;/li&gt;
&lt;/ul&gt;
&lt;ul&gt;
&lt;blockquote&gt;
&lt;p&gt;...view storm clouds by radar...&lt;/p&gt;
&lt;/blockquote&gt;
&lt;li&gt;Define verifiable criteria
&lt;blockquote&gt;
&lt;p&gt; ...at least 100 miles ahead.&lt;/p&gt;
&lt;/blockquote&gt;
&lt;/li&gt;
&lt;/ul&gt;</mainDescription>
</org.eclipse.epf.uma:ContentDescription>