| <?xml version="1.0" encoding="UTF-8"?> |
| <!DOCTYPE html PUBLIC "-//W3C/DTD XHTML 1.0 Strict//EN" "DTD/xhtml1-strict.dtd"> |
| <!-- VERSION rmc:7.1.0 --> |
| <html xmlns="http://www.w3.org/1999/xhtml"> |
| <head> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/> |
| <!-- START NON-TRANSLATABLE --> |
| <title>\openup_basic\guidances\guidelines\writing_good_requirements.xmi</title> |
| </head> |
| <!-- WARNING: do not modify the generated comments in this file below this line. They are used as markers for the import process. --> |
| <body> |
| Element Name: writing_good_requirements.xmi<br/><br/> |
| <!-- END NON-TRANSLATABLE --> |
| <br/><br/><br/> |
| <!-- START NON-TRANSLATABLE --> |
| Attribute: presentationName<br/><br/> |
| <!-- END NON-TRANSLATABLE --> |
| <!-- START:presentationName,_6jXzYNcKEdqz_d2XWoVt6Q CRC: 3943194408 -->Writing Good Requirements<!-- END:presentationName,_6jXzYNcKEdqz_d2XWoVt6Q --> |
| <br/><br/><br/> |
| <!-- START NON-TRANSLATABLE --> |
| Attribute: briefDescription<br/><br/> |
| <!-- END NON-TRANSLATABLE --> |
| <!-- START:briefDescription,_6jXzYNcKEdqz_d2XWoVt6Q CRC: 2478461860 -->This guideline describes ways of writing good requirements.<!-- END:briefDescription,_6jXzYNcKEdqz_d2XWoVt6Q --> |
| <br/><br/><br/> |
| <!-- START NON-TRANSLATABLE --> |
| Attribute: mainDescription<br/><br/> |
| <!-- END NON-TRANSLATABLE --> |
| <!-- START:mainDescription,-AJQLv2ldVv5KN9eUbdQe_g CRC: 1305963723 --><P>To write a good requirement, |
| you must write it<strong> </strong>as a complete sentence, with a subject |
| and a predicate (usually a verb). The subject 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.</P> |
| <P>Consistent use of the verb <strong>to be </strong>solidifies |
| the link between the subject and the predicate.<strong> |
| </strong>Thus, you can analyze a requirement from |
| a grammatical point of view. </P> |
| <P>Beware of lists, bullets, and words such as <strong>all</strong>, <strong>every</strong>and <strong>some</strong>. For example:<strong> </strong></P> |
| <blockquote> |
| <p>The order entry clerk must<strong> </strong>be |
| able to complete 10 customer orders in less than two hours.</p> |
| </blockquote> |
| <P>This requirement has a subject (the order entry clerk, who<strong> |
| </strong>is an Actor), a specific and measurable |
| end state (10 customer orders completed), and a performance criterion |
| (in less than two hours).</P> |
| <P>Follow these simple guidelines<strong> </strong> |
| in writing any requirement. For consistency, these examples |
| are all in the context of an aircraft. [[WAS: is used throughout.]] <a class=elementlinkwithusertext href="./../../../openup_basic/guidances/supportingmaterials/references,_9ToeIB83Edqsvps02rpOOg.html" guid="_9ToeIB83Edqsvps02rpOOg">[TEL06]</a> |
| </P> |
| <ul> |
| <li>Define one requirement at a time. |
| <blockquote> |
| <p>The pilot shall be able to control the aircraft's angle of climb with |
| one hand.</p> |
| </blockquote> |
| </li> |
| </ul> |
| <blockquote> |
| <blockquote> |
| <p> The pilot shall be able to feel the angle of climb from the climb control.</p> |
| </blockquote> |
| </blockquote> |
| <ul> |
| <li>Avoid conjunctions (and, or) that make multiple requirements. </li> |
| </ul> |
| <blockquote> |
| <blockquote> |
| <p>The navigator shall be able to view the aircraft's position relative to |
| the route's radio beacons. </p> |
| <p>The navigator shall be able to view the aircraft's position as |
| estimated by inertial guidance.</p> |
| </blockquote> |
| </blockquote> |
| <ul> |
| <li>Avoid let-out clauses or words that imply options |
| or exceptions (unless, except, if necessary, but). </li> |
| <blockquote> |
| <p>The design shall provide a rear-facing seat |
| for each cabin crew member.</p> |
| </blockquote> |
| <li>Use simple, direct sentences. </li> |
| </ul> |
| <ul> |
| <blockquote> |
| <p>The pilot shall be able to see<strong> </strong>the |
| airspeed indicator.</p> |
| </blockquote> |
| <li>Use a limited (500-word) vocabulary, especially if your audience is international. |
| <blockquote> |
| <p>The airline shall be able to convert the |
| aircraft from business to holiday charter use in less than 12 hours </p> |
| </blockquote> |
| </li> |
| <blockquote> |
| <p><strong>Note: </strong>There is no need to use words such |
| as <strong> reconfigured. </strong></p> |
| </blockquote> |
| <li>Identify the type of user who needs each requirement. |
| </li> |
| </ul> |
| <ul> |
| <blockquote> |
| <p>The navigator shall be able to...</p> |
| </blockquote> |
| <li>Focus on stating what result you will provide<strong> |
| </strong> for that type of user. </li> |
| </ul> |
| <ul> |
| <blockquote> |
| <p>...view storm clouds by radar...</p> |
| </blockquote> |
| <li>Define verifiable criteria |
| <blockquote> |
| <p> ...at least 100 miles ahead.</p> |
| </blockquote> |
| </li> |
| </ul><!-- END:mainDescription,-AJQLv2ldVv5KN9eUbdQe_g --> |
| </body> |
| </html> |
