| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" |
| "http://www.w3.org/TR/html4/transitional.dtd"> |
| <html> |
| <head> |
| <meta HTTP-EQUIV=CONTENT-TYPE CONTENT="text/html; charset=utf-8"> |
| <title>Create Useful Documentation with Mylyn Intent : transcript</title> |
| <link rel="stylesheet" type="text/css" href="talk.css"> |
| </head> |
| <body text="#000000" bgcolor="#FFFFFF" link="#000080" vlink="#0000CC" alink="#000080"> |
| <center> |
| <a href="img0.html"><img src="first.png" border=0 alt="Première page"></a> <a href="img15.html"><img src="left.png" border=0 alt="Précédent"></a> <a href="img17.html"><img src="right.png" border=0 alt="Suivant"></a> <a href="img29.html"><img src="last.png" border=0 alt="Dernière page"></a> <a href="Intent_AgileALMConnect2012.htm"><img src="home.png" border=0 alt="Résumé"></a> <a href="text16.html"><img src="text.png" border=0 alt="Texte"></a></center><br> |
| <img src="img16.png" alt="" USEMAP="#map0" style="float:left"/> |
| |
| <p><p style="direction:ltr;">OK, so now that you saw the syntax let's see how Intent can help you keep your doc synchronized with this short example.</p> |
| <p> |
| Let's say we are developing a web portal, called <b>Offers.com</b>, that allows users to purchase items on-line. |
| Each item of the portal is associated to an <b>offer type</b>, defining the target customers and availability conditions. |
| |
| During an iteration, the customer wants us to introduce a new offer type, the <i>Special Promotion Offer Type</i>, that allows him to propose temporary discount on items. |
| <map name="map0"> |
| <area shape="rect" alt="" coords="16,121,790,557" href="./demos/demo1_synchronization/intent-demo1-sync.html"> |
| </map> |
| </p> |
| <p><i> Click on the picture or <a href="./demos/demo1_synchronization/intent-demo1-sync.html">here</a> to start the demo </i>. |
| This demo shows that when I update the requirements, Intent detects synchronization issues and when I update my code to reflect those changes documentation and code are now up-to-date. |
| <br/> |
| I can also update my code, and then rely on Intent to determine which parts of the documentation have to be updated. In that case I can decide to update the document whenever I want (continuously, |
| late or when it hurts). |
| <br/> |
| |
| The quick-outline allows you to quickly get all the documentation changes relative to some concern/technical aspect of my software (here the offer description).</p><p> |
| <b>Notice that the example shows Java code synchronization but this can work for any techical artifact : C/C++ code, XML files, manifests...<b> |
| </p> |
| </body> |
| </html> |