Changeset 60:c074fc456b2a
- Timestamp:
- 02/22/07 15:18:53 (18 months ago)
- Author:
- Tarek Ziad?? <tarek@…>
- Message:
-
more
- Location:
- PyCon07
- Files:
-
Legend:
- Unmodified
- Added
- Removed
-
|
r59
|
r60
|
|
| 62 | 62 | ::::::::::::: |
| 63 | 63 | |
| 64 | | - Grab the picture here: http://upload.wikimedia.org/wikipedia/en/thumb/c/cb/Flyingcircus_2.jpg/300px-Flyingcircus_2.jpg |
| | 64 | - Grab the picture here: http://upload.wikimedia.org/wikipedia/en/thumb/c/cb/Flyingcircus_2.jpg/300px-Flyingcircus_2.jpg or on the provided example. |
| 65 | 65 | |
| 66 | 66 | Exercise 3 |
-
|
r47
|
r60
|
|
| 82 | 82 | |
| 83 | 83 | |important| Think documents like code. Always limit the size of sections, |
| 84 | | and documents. Modularized documentation is the key. |
| | 84 | examples, etc. Modularized documentation is the key. |
| 85 | 85 | |
| 86 | 86 | Structured documents |
| … |
… |
|
| 148 | 148 | - diagrams |
| 149 | 149 | |
| | 150 | .. |important| image:: important.png |
| | 151 | |
-
|
r58
|
r60
|
|
| 430 | 430 | <li>example (Tarek, switch on)</li> |
| 431 | 431 | <li>cheatsheet</li> |
| | 432 | <li>see <a class="reference" href="http://docutils.sf.net">http://docutils.sf.net</a></li> |
| 432 | 433 | </ul> |
| 433 | 434 | </div> |
| … |
… |
|
| 493 | 494 | <div class="slide" id="realistic-examples"> |
| 494 | 495 | <h1>Realistic examples</h1> |
| 495 | | <p>Drop the <em>foo</em> and <em>bar</em> habits. Examples must be real-life examples, and |
| 496 | | usable as-is.</p> |
| | 496 | <p>Drop the <em>foo</em> and <em>bar</em> habits. Examples must be real-life examples:</p> |
| 497 | 497 | <p>Neh:</p> |
| 498 | 498 | <pre class="literal-block"> |
| … |
… |
|
| 515 | 515 | <p><img alt="important" src="media/important.png" /> Spending too much time to find something in the documentation is |
| 516 | 516 | a bad sign.</p> |
| 517 | | <p><img alt="important" src="media/important.png" /> Think documents like code. Always limit the size of sections, |
| 518 | | and documents.</p> |
| | 517 | <p><img alt="important" src="media/important.png" /> Think documents like code. Always limit the size of its sections, |
| | 518 | examples, etc.</p> |
| 519 | 519 | <p><img alt="wink" src="media/wink.png" /> Modularized documentation is the key.</p> |
| 520 | 520 | </div> |
| … |
… |
|
| 861 | 861 | </ul> |
| 862 | 862 | </div> |
| | 863 | <div class="slide" id="pycommunity"> |
| | 864 | <h1>PyCommunity</h1> |
| | 865 | <p>A tool that:</p> |
| | 866 | <ul class="simple"> |
| | 867 | <li>reads a bundle</li> |
| | 868 | <li>extract its documentation</li> |
| | 869 | <li>generates a website with it</li> |
| | 870 | <li>is not released yet (soon <img alt="wink" src="media/wink.png" />)</li> |
| | 871 | </ul> |
| | 872 | </div> |
| | 873 | <div class="slide" id="id29"> |
| | 874 | <h1>PyCommunity</h1> |
| | 875 | <ul class="simple"> |
| | 876 | <li>can be hooked in the subversion post-commit hook</li> |
| | 877 | <li>can be configured to inject its generated page in an existing site</li> |
| | 878 | </ul> |
| | 879 | <p><img alt="smile" src="media/smile.png" /> let's try it #exercise 11</p> |
| | 880 | </div> |
| | 881 | <div class="slide" id="conclusions"> |
| | 882 | <h1>Conclusions</h1> |
| | 883 | <ul class="simple"> |
| | 884 | <li>Using <cite>DDD</cite> is a good way to enhance the QA</li> |
| | 885 | <li>It is enjoyed by most developers</li> |
| | 886 | <li>It increases both writing and programming skills</li> |
| | 887 | </ul> |
| | 888 | </div> |
| | 889 | <div class="slide" id="the-end"> |
| | 890 | <h1>The end</h1> |
| | 891 | <ul class="simple"> |
| | 892 | <li>Thank you !</li> |
| | 893 | <li>Questions ? Answers ?</li> |
| | 894 | </ul> |
| | 895 | </div> |
| | 896 | <div class="slide" id="references"> |
| | 897 | <h1>References</h1> |
| | 898 | <p>Useful books:</p> |
| | 899 | <ul class="simple"> |
| | 900 | <li>"Writing with Power" - Peter Elbow</li> |
| | 901 | <li>"Agile Documentation" - Andreas RÃŒping</li> |
| | 902 | </ul> |
| | 903 | <p>Useful websites:</p> |
| | 904 | <ul class="simple"> |
| | 905 | <li><a class="reference" href="http://emenciacommerce.com/en">http://emenciacommerce.com/en</a>: Emencia Commerce Suite - My company software</li> |
| | 906 | <li><a class="reference" href="http://tarekziade.wordpress.com">http://tarekziade.wordpress.com</a> : My blog</li> |
| | 907 | </ul> |
| | 908 | </div> |
| | 909 | <div class="slide" id="incoming-events"> |
| | 910 | <h1>Incoming Events</h1> |
| | 911 | <p>You all go to Rupy in Poznan, Polan, 14/15 April <img alt="wink" src="media/wink.png" /></p> |
| | 912 | </div> |
| 863 | 913 | </div> |
| 864 | 914 | </body> |
-
|
r59
|
r60
|
|
| 114 | 114 | - example (Tarek, switch on) |
| 115 | 115 | - cheatsheet |
| | 116 | - see http://docutils.sf.net |
| 116 | 117 | |
| 117 | 118 | Mastering reSTructuredText |
| … |
… |
|
| 189 | 190 | ================== |
| 190 | 191 | |
| 191 | | Drop the *foo* and *bar* habits. Examples must be real-life examples, and |
| 192 | | usable as-is. |
| | 192 | Drop the *foo* and *bar* habits. Examples must be real-life examples: |
| 193 | 193 | |
| 194 | 194 | Neh:: |
| … |
… |
|
| 215 | 215 | a bad sign. |
| 216 | 216 | |
| 217 | | |important| Think documents like code. Always limit the size of sections, |
| 218 | | and documents. |
| | 217 | |important| Think documents like code. Always limit the size of its sections, |
| | 218 | examples, etc. |
| 219 | 219 | |
| 220 | 220 | |wink| Modularized documentation is the key. |
| … |
… |
|
| 255 | 255 | |
| 256 | 256 | Let's do exercise #4 to feel it |glasses| |
| | 257 | |
| | 258 | Topic ideas: |
| | 259 | |
| | 260 | - cooking recipe |
| | 261 | - how to play a board or card game |
| | 262 | - how to fish shrimps |
| | 263 | |
| 257 | 264 | |
| 258 | 265 | Writing a document |