| <!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="img11.html"><img src="left.png" border=0 alt="Précédent"></a> <a href="img13.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_ece2011.htm"><img src="home.png" border=0 alt="Résumé"></a> <a href="text12.html"><img src="text.png" border=0 alt="Texte"></a></center><br> |
| <img src="img12.png" alt="" style="float:left"/> |
| |
| <p><p style="direction:ltr;">This contribution mechanism allows us to split your documentation across concerns, free from any structural constraint due to your implementation language.</p> |
| <p style="direction:ltr;"></p> |
| <p style="direction:ltr;">This improves the readability of your doc, as your reader will be able to have a step by step reading. This also <b>improves the readability of your code</b> |
| , as you can focus on the parts of the code that fulfills the concern that interests you right now. |
| |
| </p> |
| <p style="direction:ltr;">Let's take a concrete example. On one side, you've got the Intent document I use to document the Intent code. |
| On the other side, you've got Intent code itself. |
| <br/> |
| In a first section, that gives a very high-level overview of the synchronization, I do not enter into technical details, focusing on describing what |
| is synchronization (defining requirements and high-level architecture). |
| </p> |
| </body> |
| </html> |
