OpenUP/OpenUP_baseline_EN/exported_HTML_1_0/openup/guidances/checklists/implementation.html - epf/org.eclipse.epf.nl-libraries - Git at Google

 <?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&amp;#92;guidances&amp;#92;checklists&amp;#92;&amp;#92;implementation.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: implementation.xmi<br/><br/>
 <!-- END NON-TRANSLATABLE -->
 <br/><br/><br/>
 <!-- START NON-TRANSLATABLE -->
 Attribute: presentationName<br/><br/>
 <!-- END NON-TRANSLATABLE -->
 <!-- START:presentationName,_OhJKUNWsEduaE6F4-SvXzg CRC: 263885700 -->Implementation<!-- END:presentationName,_OhJKUNWsEduaE6F4-SvXzg -->
 <br/><br/><br/>
 <!-- START NON-TRANSLATABLE -->
 Attribute: briefDescription<br/><br/>
 <!-- END NON-TRANSLATABLE -->
 <!-- START:briefDescription,_OhJKUNWsEduaE6F4-SvXzg CRC: 557517249 -->This checklist provides questions to verify that the implementation is created in a consistent and complete manner.<!-- END:briefDescription,_OhJKUNWsEduaE6F4-SvXzg -->
 <br/><br/><br/>
 <!-- START NON-TRANSLATABLE -->
 Attribute: mainDescription<br/><br/>
 <!-- END NON-TRANSLATABLE -->
 <!-- START:mainDescription,-mFnoIulBQ7JrxiaHVCrE7A CRC: 3085774580 --><p>
     The items in this checklist represent good practices for creating a high-quality implementation. Try to address every
     item to the greatest extent possible to create the best implementation. It may not be possible to address every item,
     and you may be able to address some items to only a limited extent. In these cases, be sure that there are good reasons
     for only partially addressing an item or not addressing an item at all.
 </p>
 <p>
     This checklist is not something that should be considered only for heavyweight code reviews. Each developer should keep
     the quality criteria embodied in these check items in mind while coding. When developers work together, the review
     against these criteria should be done in real time so that quality is ensured up front as they are writing the code.
 </p>
 <p>
     Appropriate divergence from the quality criteria described here could be worthy of a comment in the implementation so
     that developers examining the code in the future know why the exception occurred.
 </p><!-- END:mainDescription,-mFnoIulBQ7JrxiaHVCrE7A -->
 <br/><br/><br/>
 <!-- START NON-TRANSLATABLE -->
 Attribute: name<br/><br/>
 <!-- END NON-TRANSLATABLE -->
 <!-- START:name,_q8zSoNWsEduaE6F4-SvXzg CRC: 952532205 -->Does the implementation conform to the architecture and design?<!-- END:name,_q8zSoNWsEduaE6F4-SvXzg -->
 <br/><br/><br/>
 <!-- START NON-TRANSLATABLE -->
 Attribute: sectionDescription<br/><br/>
 <!-- END NON-TRANSLATABLE -->
 <!-- START:sectionDescription,_q8zSoNWsEduaE6F4-SvXzg CRC: 457020075 --><ul>
   <li> Is the implementation structured as specified in the design? </li>
   <li> Are all of the functions in the design implemented? </li>
   <li> Are all of the interfaces in the design implemented according to their
     specifications? </li>
   <li> Does the implementation adhere to all design and architectural constraints?
   </li>
 </ul><!-- END:sectionDescription,_q8zSoNWsEduaE6F4-SvXzg -->
 <br/><br/><br/>
 <!-- START NON-TRANSLATABLE -->
 Attribute: name<br/><br/>
 <!-- END NON-TRANSLATABLE -->
 <!-- START:name,_vb-zsNWsEduaE6F4-SvXzg CRC: 1446418482 -->Is the implementation testable?<!-- END:name,_vb-zsNWsEduaE6F4-SvXzg -->
 <br/><br/><br/>
 <!-- START NON-TRANSLATABLE -->
 Attribute: sectionDescription<br/><br/>
 <!-- END NON-TRANSLATABLE -->
 <!-- START:sectionDescription,_vb-zsNWsEduaE6F4-SvXzg CRC: 3114491865 --><ul>
   <li> Can you test the expected behavior at the unit level? </li>
   <li> Is the code written in a way that all paths can be exercised? </li>
 </ul><!-- END:sectionDescription,_vb-zsNWsEduaE6F4-SvXzg -->
 <br/><br/><br/>
 <!-- START NON-TRANSLATABLE -->
 Attribute: name<br/><br/>
 <!-- END NON-TRANSLATABLE -->
 <!-- START:name,_djoQENXCEduaE6F4-SvXzg CRC: 2602696070 -->Is the implementation correct?<!-- END:name,_djoQENXCEduaE6F4-SvXzg -->
 <br/><br/><br/>
 <!-- START NON-TRANSLATABLE -->
 Attribute: sectionDescription<br/><br/>
 <!-- END NON-TRANSLATABLE -->
 <!-- START:sectionDescription,_djoQENXCEduaE6F4-SvXzg CRC: 468623068 --><ul>
   <li> Does the implementation pass all of the developer tests? </li>
   <li> Does the implementation support the acceptance criteria of the test cases?
   </li>
   <li> Is all code executable (no dead code areas)? </li>
 </ul><!-- END:sectionDescription,_djoQENXCEduaE6F4-SvXzg -->
 <br/><br/><br/>
 <!-- START NON-TRANSLATABLE -->
 Attribute: name<br/><br/>
 <!-- END NON-TRANSLATABLE -->
 <!-- START:name,_D4YyoO24EduHHNqbab9GOA CRC: 2899089297 -->Is the implementation understandable?<!-- END:name,_D4YyoO24EduHHNqbab9GOA -->
 <br/><br/><br/>
 <!-- START NON-TRANSLATABLE -->
 Attribute: sectionDescription<br/><br/>
 <!-- END NON-TRANSLATABLE -->
 <!-- START:sectionDescription,_D4YyoO24EduHHNqbab9GOA CRC: 1245514500 --><ul>
   <li> Does the implementation clearly state the intention of the developer? </li>
   <li> Does the code adhere to the Coding Guidelines? If a set of Coding Guidelines
     has not been identified, the code should be checked for a variety of consistency
     issues, such as naming conventions, indentation, spacing, and so forth.</li>
   <li> Are the names of the variables easy to understand? Do they describe the
     purpose of the variable? </li>
   <li> Are all of the comments necessary to be able to understand the associated
     code? Comments should enhance the understanding of the code rather than merely
     repeat it. </li>
   <li> Are all comments correct? </li>
   <li> Does the implementation match the documentation? </li>
 </ul><!-- END:sectionDescription,_D4YyoO24EduHHNqbab9GOA -->
 <br/><br/><br/>
 <!-- START NON-TRANSLATABLE -->
 Attribute: name<br/><br/>
 <!-- END NON-TRANSLATABLE -->
 <!-- START:name,_klOGANvBEduy3tw_ntB-3g CRC: 89526829 -->Is there no redundancy?<!-- END:name,_klOGANvBEduy3tw_ntB-3g -->
 <br/><br/><br/>
 <!-- START NON-TRANSLATABLE -->
 Attribute: sectionDescription<br/><br/>
 <!-- END NON-TRANSLATABLE -->
 <!-- START:sectionDescription,_klOGANvBEduy3tw_ntB-3g CRC: 2885062080 --><p> Is there no redundancy in the implementation? (Identify candidates for refactoring.)
 </p><!-- END:sectionDescription,_klOGANvBEduy3tw_ntB-3g -->
 </body>
 </html>
	<?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&#92;guidances&#92;checklists&#92;&#92;implementation.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: implementation.xmi<br/><br/>
	<!-- END NON-TRANSLATABLE -->
	<br/><br/><br/>
	<!-- START NON-TRANSLATABLE -->
	Attribute: presentationName<br/><br/>
	<!-- END NON-TRANSLATABLE -->
	<!-- START:presentationName,_OhJKUNWsEduaE6F4-SvXzg CRC: 263885700 -->Implementation<!-- END:presentationName,_OhJKUNWsEduaE6F4-SvXzg -->
	<br/><br/><br/>
	<!-- START NON-TRANSLATABLE -->
	Attribute: briefDescription<br/><br/>
	<!-- END NON-TRANSLATABLE -->
	<!-- START:briefDescription,_OhJKUNWsEduaE6F4-SvXzg CRC: 557517249 -->This checklist provides questions to verify that the implementation is created in a consistent and complete manner.<!-- END:briefDescription,_OhJKUNWsEduaE6F4-SvXzg -->
	<br/><br/><br/>
	<!-- START NON-TRANSLATABLE -->
	Attribute: mainDescription<br/><br/>
	<!-- END NON-TRANSLATABLE -->
	<!-- START:mainDescription,-mFnoIulBQ7JrxiaHVCrE7A CRC: 3085774580 --><p>
	The items in this checklist represent good practices for creating a high-quality implementation. Try to address every
	item to the greatest extent possible to create the best implementation. It may not be possible to address every item,
	and you may be able to address some items to only a limited extent. In these cases, be sure that there are good reasons
	for only partially addressing an item or not addressing an item at all.
	</p>
	<p>
	This checklist is not something that should be considered only for heavyweight code reviews. Each developer should keep
	the quality criteria embodied in these check items in mind while coding. When developers work together, the review
	against these criteria should be done in real time so that quality is ensured up front as they are writing the code.
	</p>
	<p>
	Appropriate divergence from the quality criteria described here could be worthy of a comment in the implementation so
	that developers examining the code in the future know why the exception occurred.
	</p><!-- END:mainDescription,-mFnoIulBQ7JrxiaHVCrE7A -->
	<br/><br/><br/>
	<!-- START NON-TRANSLATABLE -->
	Attribute: name<br/><br/>
	<!-- END NON-TRANSLATABLE -->
	<!-- START:name,_q8zSoNWsEduaE6F4-SvXzg CRC: 952532205 -->Does the implementation conform to the architecture and design?<!-- END:name,_q8zSoNWsEduaE6F4-SvXzg -->
	<br/><br/><br/>
	<!-- START NON-TRANSLATABLE -->
	Attribute: sectionDescription<br/><br/>
	<!-- END NON-TRANSLATABLE -->
	<!-- START:sectionDescription,_q8zSoNWsEduaE6F4-SvXzg CRC: 457020075 --><ul>
	<li> Is the implementation structured as specified in the design? </li>
	<li> Are all of the functions in the design implemented? </li>
	<li> Are all of the interfaces in the design implemented according to their
	specifications? </li>
	<li> Does the implementation adhere to all design and architectural constraints?
	</li>
	</ul><!-- END:sectionDescription,_q8zSoNWsEduaE6F4-SvXzg -->
	<br/><br/><br/>
	<!-- START NON-TRANSLATABLE -->
	Attribute: name<br/><br/>
	<!-- END NON-TRANSLATABLE -->
	<!-- START:name,_vb-zsNWsEduaE6F4-SvXzg CRC: 1446418482 -->Is the implementation testable?<!-- END:name,_vb-zsNWsEduaE6F4-SvXzg -->
	<br/><br/><br/>
	<!-- START NON-TRANSLATABLE -->
	Attribute: sectionDescription<br/><br/>
	<!-- END NON-TRANSLATABLE -->
	<!-- START:sectionDescription,_vb-zsNWsEduaE6F4-SvXzg CRC: 3114491865 --><ul>
	<li> Can you test the expected behavior at the unit level? </li>
	<li> Is the code written in a way that all paths can be exercised? </li>
	</ul><!-- END:sectionDescription,_vb-zsNWsEduaE6F4-SvXzg -->
	<br/><br/><br/>
	<!-- START NON-TRANSLATABLE -->
	Attribute: name<br/><br/>
	<!-- END NON-TRANSLATABLE -->
	<!-- START:name,_djoQENXCEduaE6F4-SvXzg CRC: 2602696070 -->Is the implementation correct?<!-- END:name,_djoQENXCEduaE6F4-SvXzg -->
	<br/><br/><br/>
	<!-- START NON-TRANSLATABLE -->
	Attribute: sectionDescription<br/><br/>
	<!-- END NON-TRANSLATABLE -->
	<!-- START:sectionDescription,_djoQENXCEduaE6F4-SvXzg CRC: 468623068 --><ul>
	<li> Does the implementation pass all of the developer tests? </li>
	<li> Does the implementation support the acceptance criteria of the test cases?
	</li>
	<li> Is all code executable (no dead code areas)? </li>
	</ul><!-- END:sectionDescription,_djoQENXCEduaE6F4-SvXzg -->
	<br/><br/><br/>
	<!-- START NON-TRANSLATABLE -->
	Attribute: name<br/><br/>
	<!-- END NON-TRANSLATABLE -->
	<!-- START:name,_D4YyoO24EduHHNqbab9GOA CRC: 2899089297 -->Is the implementation understandable?<!-- END:name,_D4YyoO24EduHHNqbab9GOA -->
	<br/><br/><br/>
	<!-- START NON-TRANSLATABLE -->
	Attribute: sectionDescription<br/><br/>
	<!-- END NON-TRANSLATABLE -->
	<!-- START:sectionDescription,_D4YyoO24EduHHNqbab9GOA CRC: 1245514500 --><ul>
	<li> Does the implementation clearly state the intention of the developer? </li>
	<li> Does the code adhere to the Coding Guidelines? If a set of Coding Guidelines
	has not been identified, the code should be checked for a variety of consistency
	issues, such as naming conventions, indentation, spacing, and so forth.</li>
	<li> Are the names of the variables easy to understand? Do they describe the
	purpose of the variable? </li>
	<li> Are all of the comments necessary to be able to understand the associated
	code? Comments should enhance the understanding of the code rather than merely
	repeat it. </li>
	<li> Are all comments correct? </li>
	<li> Does the implementation match the documentation? </li>
	</ul><!-- END:sectionDescription,_D4YyoO24EduHHNqbab9GOA -->
	<br/><br/><br/>
	<!-- START NON-TRANSLATABLE -->
	Attribute: name<br/><br/>
	<!-- END NON-TRANSLATABLE -->
	<!-- START:name,_klOGANvBEduy3tw_ntB-3g CRC: 89526829 -->Is there no redundancy?<!-- END:name,_klOGANvBEduy3tw_ntB-3g -->
	<br/><br/><br/>
	<!-- START NON-TRANSLATABLE -->
	Attribute: sectionDescription<br/><br/>
	<!-- END NON-TRANSLATABLE -->
	<!-- START:sectionDescription,_klOGANvBEduy3tw_ntB-3g CRC: 2885062080 --><p> Is there no redundancy in the implementation? (Identify candidates for refactoring.)
	</p><!-- END:sectionDescription,_klOGANvBEduy3tw_ntB-3g -->
	</body>
	</html>