## *Thomas* Parisot
[thom4.net](https://thom4.net) –
[@thom4parisot](https://twitter.com/thom4parisot)
@@@
@@@
@@@
## BBC R&D
[github.com/bbcrd](https://github.com/bbcrd)
[bbc.co.uk/rd](http://bbc.co.uk/rd)
@@@
[npmjs.org/~thom4](https://npmjs.org/~thom4)
@@@
[](http://sudweb.fr)
# README
## un fichier nommé plaisir
6 mars 2014 — [ChtiJS](http://www.meetup.com/FranceJS/events/168885592/)
# Retour à la réalité
@@@
@@@
@@@
@@@
@@@
# Paradoxe
@@@
# Temps
investi pour créer
@@@
# Plaisir
que l'on pourrait avoir à créer
@@@
# Satisfaction
de partager
@@@
# 2011
@@@
# Paris Web
Dialoguer = parler + écouter
@@@
# Startup
4 développeurs, *confiance* et télétravail.
@@@
# Envie de *simplicité*
~~cahier des charges~~, sprints et machine à café.
@@@
# Choix les *outils*
GitHub, JavaScript et `npm install`.
@@@
# {1, *5*} *projets*
@@@
> Comment ça s'*installe* ?
> Comment on *met à jour* ?
> C'est quoi déjà la commande pour *tester* ?
@@@
# Besoin
## de mieux *documenter*.
# README
## ------ -----------
@@@
# Évidence
Premier fichier présenté sur GitHub.
@@@
La nature a horreur du vide.
@@@
Les *README* aussi.
# README ?
@@@
# Simple
`#` + `*` + `**` + `[]()` + `![]()` + ` ``` `
@@@
# Rapide
à apprendre, à écrire.
@@@
# Pervasif
HTML, PDF, JSON, texte etc.
cf. [pandoc](http://johnmacfarlane.net/pandoc/).
@@@
# Synthétique
Où, quand, quoi, comment, combien et pourquoi.
@@@
# Content First
La technique reste en retrait.
# Bref
Un écrit qui nous a parlé.
@@@
# Simplicité
mesurée au regard.
@@@
# Inclus
dans le code source du projet.
@@@
# Maîtrise
de sa consommation.
# README
## Driven -----------
@@@
# ?
@@@
# Commencer
par le README.
@@@
# *Avant* le code
@@@
# Être clair
Avec soi-même et son équipe.
@@@
# Designer
Preuve par l'exemple.
@@@
# Feedback
Retours et corrections *avant* de coder.
@@@
# Sketching
Rapide, essentiel et … *facile*.
# README
## Driven Development
@@@
# Tests
@@@
# Pull Request
[Mieux vaut plusieurs qu'une seule](https://thom4.net/2013/the-55-commits-syndrome/).
# Bref
@@@
# Point d'entrée
unique.
@@@
# Documente
la vision.
@@@
# Illustre
les intentions.
@@@
# Facilite
le dialogue.
@@@
# Réduit
le *time to code*.
@@@
# Simple, non ?
# Merci !
## Des questions ?
@@@
# Credits
* https://xkcd.com/927/
* [Thanh](http://clients.tranches-de-vie.com/index.php/2011/paris-web-2011/1015-ateliers/img-0275)
@@@
# Ressources
* Ils en parlent :
* [Tom Preston-Werner](http://tom.preston-werner.com/2010/08/23/readme-driven-development.html)
* [Mark Rickerby](http://www.slideshare.net/maetl/readme-driven-development-12783652)
* [github.com/moonmaster9000/specdown](https://github.com/moonmaster9000/specdown)