============
DDD Tutorial
============

PART 1 - 30mn
-------------

Writing a document - 30 mn
==========================

Mastering reStructuredText
::::::::::::::::::::::::::

- slides: presentation of reStructuredText
- distribution of cheatsheet
- exercises

 - exercise 1: mastering basic syntax
 - exercise 2: mastering advanced syntax 

Writing techniques and tips
:::::::::::::::::::::::::::

- slides:
 
 - presentation of the seven laws
 - the loop writing process

- exercises

 - exercise 3: text optimization

Team writing
::::::::::::

- slides: bad writer, good designer VS good writer, bad designer
- exercises: 

 - exercice 4: pair-documenting

PART 2 - 45mn
-------------

Writing documents in Python - 15 mn
===================================

Documenting code
::::::::::::::::

- slides: how to document code ?

Documenting a module
::::::::::::::::::::

- slides: which module to document, how to split content into docs ?
- exercises:

 - exercice 5: document the `pycommunity` package modules

Documenting a package
:::::::::::::::::::::

- slides: README.txt and friends
- exercises: 

 - exercise 6: add mandatory files in the `pycommunity` package

Using documents for test-driven developement - 30 mn
====================================================

Mastering doctests
::::::::::::::::::

- slides: unittests ain't doctests
- exercises: 

 - exercise 7: Learn how to doctest

Continuous documentation
::::::::::::::::::::::::

- slides: design through doctests
- exercises: 

 - exercise 8: creating a module with its doctest

**BREAK - 15 mn**

Part 3 - 1h15
-------------

Writing documents in a Python Project - 1h
==========================================

Writing tutorials
:::::::::::::::::

- slides: what's a tutorial, how to write a tutorial

- exercises: 
    - exercise 9: write a mini-tutorial

Writing cookbook and recipes
::::::::::::::::::::::::::::

- slides: what's a cookbook, how to write a recipe

- exercises: 
    - exercice 10 : write some recipes

Writing a project glossary
::::::::::::::::::::::::::

    - exercise: write a glossary

  - crosslinking everything
    - exercice: link the recipe, tutorial and glossary

Website autogeneration with pycommunity - 20 mn  
===============================================

- presentation: pycommunity

- exercises:
    
    - exercise 11: pycommunity tests
    - customize pycommunity for an existing website

- conclusions, Q/A, 10 mn