| 1 | ============ |
|---|
| 2 | DDD Tutorial |
|---|
| 3 | ============ |
|---|
| 4 | |
|---|
| 5 | PART 1 - 30mn |
|---|
| 6 | ------------- |
|---|
| 7 | |
|---|
| 8 | Writing a document - 30 mn |
|---|
| 9 | ========================== |
|---|
| 10 | |
|---|
| 11 | Mastering reStructuredText |
|---|
| 12 | :::::::::::::::::::::::::: |
|---|
| 13 | |
|---|
| 14 | - slides: presentation of reStructuredText |
|---|
| 15 | - distribution of cheatsheet |
|---|
| 16 | - exercises |
|---|
| 17 | |
|---|
| 18 | - exercise 1: mastering basic syntax |
|---|
| 19 | - exercise 2: mastering advanced syntax |
|---|
| 20 | |
|---|
| 21 | Writing techniques and tips |
|---|
| 22 | ::::::::::::::::::::::::::: |
|---|
| 23 | |
|---|
| 24 | - slides: |
|---|
| 25 | |
|---|
| 26 | - presentation of the seven laws |
|---|
| 27 | - the loop writing process |
|---|
| 28 | |
|---|
| 29 | - exercises |
|---|
| 30 | |
|---|
| 31 | - exercise 3: text optimization |
|---|
| 32 | |
|---|
| 33 | Team writing |
|---|
| 34 | :::::::::::: |
|---|
| 35 | |
|---|
| 36 | - slides: bad writer, good designer VS good writer, bad designer |
|---|
| 37 | - exercises: |
|---|
| 38 | |
|---|
| 39 | - exercice 4: pair-documenting |
|---|
| 40 | |
|---|
| 41 | PART 2 - 45mn |
|---|
| 42 | ------------- |
|---|
| 43 | |
|---|
| 44 | Writing documents in Python - 15 mn |
|---|
| 45 | =================================== |
|---|
| 46 | |
|---|
| 47 | Documenting code |
|---|
| 48 | :::::::::::::::: |
|---|
| 49 | |
|---|
| 50 | - slides: how to document code ? |
|---|
| 51 | |
|---|
| 52 | Documenting a module |
|---|
| 53 | :::::::::::::::::::: |
|---|
| 54 | |
|---|
| 55 | - slides: which module to document, how to split content into docs ? |
|---|
| 56 | - exercises: |
|---|
| 57 | |
|---|
| 58 | - exercice 5: document the `pycommunity` package modules |
|---|
| 59 | |
|---|
| 60 | Documenting a package |
|---|
| 61 | ::::::::::::::::::::: |
|---|
| 62 | |
|---|
| 63 | - slides: README.txt and friends |
|---|
| 64 | - exercises: |
|---|
| 65 | |
|---|
| 66 | - exercise 6: add mandatory files in the `pycommunity` package |
|---|
| 67 | |
|---|
| 68 | Using documents for test-driven developement - 30 mn |
|---|
| 69 | ==================================================== |
|---|
| 70 | |
|---|
| 71 | Mastering doctests |
|---|
| 72 | :::::::::::::::::: |
|---|
| 73 | |
|---|
| 74 | - slides: unittests ain't doctests |
|---|
| 75 | - exercises: |
|---|
| 76 | |
|---|
| 77 | - exercise 7: Learn how to doctest |
|---|
| 78 | |
|---|
| 79 | Continuous documentation |
|---|
| 80 | :::::::::::::::::::::::: |
|---|
| 81 | |
|---|
| 82 | - slides: design through doctests |
|---|
| 83 | - exercises: |
|---|
| 84 | |
|---|
| 85 | - exercise 8: creating a module with its doctest |
|---|
| 86 | |
|---|
| 87 | **BREAK - 15 mn** |
|---|
| 88 | |
|---|
| 89 | Part 3 - 1h15 |
|---|
| 90 | ------------- |
|---|
| 91 | |
|---|
| 92 | Writing documents in a Python Project - 1h |
|---|
| 93 | ========================================== |
|---|
| 94 | |
|---|
| 95 | Writing tutorials |
|---|
| 96 | ::::::::::::::::: |
|---|
| 97 | |
|---|
| 98 | - slides: what's a tutorial, how to write a tutorial |
|---|
| 99 | |
|---|
| 100 | - exercises: |
|---|
| 101 | - exercise 9: write a mini-tutorial |
|---|
| 102 | |
|---|
| 103 | Writing cookbook and recipes |
|---|
| 104 | :::::::::::::::::::::::::::: |
|---|
| 105 | |
|---|
| 106 | - slides: what's a cookbook, how to write a recipe |
|---|
| 107 | |
|---|
| 108 | - exercises: |
|---|
| 109 | - exercice 10 : write some recipes |
|---|
| 110 | |
|---|
| 111 | Writing a project glossary |
|---|
| 112 | :::::::::::::::::::::::::: |
|---|
| 113 | |
|---|
| 114 | - exercise: write a glossary |
|---|
| 115 | |
|---|
| 116 | - crosslinking everything |
|---|
| 117 | - exercice: link the recipe, tutorial and glossary |
|---|
| 118 | |
|---|
| 119 | Website autogeneration with pycommunity - 20 mn |
|---|
| 120 | =============================================== |
|---|
| 121 | |
|---|
| 122 | - presentation: pycommunity |
|---|
| 123 | |
|---|
| 124 | - exercises: |
|---|
| 125 | |
|---|
| 126 | - exercise 11: pycommunity tests |
|---|
| 127 | - customize pycommunity for an existing website |
|---|
| 128 | |
|---|
| 129 | - conclusions, Q/A, 10 mn |
|---|
