tomee-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From build...@apache.org
Subject svn commit: r797838 - /websites/staging/openejb/trunk/content/dev/writing-examples.html
Date Tue, 01 Nov 2011 04:57:16 GMT
Author: buildbot
Date: Tue Nov  1 04:57:15 2011
New Revision: 797838

Log:
Staging update by buildbot

Modified:
    websites/staging/openejb/trunk/content/dev/writing-examples.html

Modified: websites/staging/openejb/trunk/content/dev/writing-examples.html
==============================================================================
--- websites/staging/openejb/trunk/content/dev/writing-examples.html (original)
+++ websites/staging/openejb/trunk/content/dev/writing-examples.html Tue Nov  1 04:57:15 2011
@@ -3,7 +3,7 @@
   <head>
 
     <meta charset="utf-8">
-      <title>Writing Examples</title>
+      <title>Writing Presentable Examples</title>
     <meta name="description" content="">
     <meta name="author" content="">
 
@@ -69,9 +69,13 @@
 
 <div class="page-header">
 <small><a href="./..//index.html">Home</a>&nbsp;&raquo&nbsp;<a
href="./..//dev/">Dev</a></small><br>
-<h1>Writing Examples</h1>
+<h1>Writing Presentable Examples</h1>
 </div>
 
+<p>Writing an example is easy.  Any example is a good one.  The more the better.</p>
+
+<p>Writing examples that can be used in a presentations is hard.</p>
+
 <p>Some basic guideliness of writing examples:</p>
 
 <ul>
@@ -88,22 +92,24 @@
 
 <h1>Noise vs signal</h1>
 
+<p>It takes time to learn the example scenario (noise).  You need to learn the scenario
before you can start to see the imporant parts (signal).</p>
+
+<p>Be very mindful of your noise to signal ratio.</p>
+
 <p>Example scenarios do not need to be believable and should not be elaborate.  Get
to the point in as few classes as possible.</p>
 
 <p>You should be able to explain the entire example in two minutes.</p>
 
-<h1>5 was to do the same thing</h1>
+<h1>Five ways to do the same thing</h1>
 
-<p>It takes time to learn the example scenario.  Be very mindful of that.</p>
-
-<p>If there are five ways to do the same thing, avoid making 5 different different
scenarios.  Copy the example to a new directory, and tweak it to show the variation.</p>
+<p>If there are five ways to do the same thing, avoid making five different scenarios.
 Copy the example to a new directory, and tweak it to show the variation.</p>
 
 <p>So say you used objects <code>Green</code>, <code>Square</code>
and <code>Checkers</code> to show the basic concept and you wish to show the next
variation of that same concecpt.  It is tempting to add to the same
 example objects <code>Yellow</code>, <code>Triangle</code> and <code>PolkaDots</code>.</p>
 
 <p>Avoid that.  Copy <code>Green</code>, <code>Square</code>
and <code>Checkers</code> to a new example, change the package name, and update
the few lines needed to show the difference.</p>
 
-<p>Which is easier to learn?</p>
+<p>Where does your eye focus?</p>
 
 <ul>
 <li>934 + 55 = 989</li>
@@ -113,7 +119,7 @@ example objects <code>Yellow</code>, <co
 <li>401 % 63 = 23</li>
 </ul>
 
-<p>Or:</p>
+<p>How about now?</p>
 
 <ul>
 <li>102 + 35 = 137</li>
@@ -123,6 +129,8 @@ example objects <code>Yellow</code>, <co
 <li>102 % 35 = 32</li>
 </ul>
 
+<p>The intent of the second set of numbers can be easily guessed.  An explanation that
it is about the math operators confirms that and locks it in your brain.</p>
+
 <p>When presenting, you only get so much time to show people ideas.  If they have to
learn a new set of names and understand their relationship on each tiny variation, it severely
 impacts their ability to see what is supposed to be the same and what is supposed to be different.
 As a presenter this means you must show less and what you do show will be shown
 less clearly.</p>



Mime
View raw message