20140311 - Documentation intrinsèque - Human Talks

50 %
50 %
Information about 20140311 - Documentation intrinsèque - Human Talks
Technology

Published on March 15, 2014

Author: ClementBouillier

Source: slideshare.net

Documentation intrinsèque Human Talks Lyon – Mars 2014 – Hébergé par l’INSA Clément Bouillier - @clem_bouillier

Qui suis-je ? Architecte/chef de projet/consultant mais avant tout ARTISAN DEVELOPPEUR > Twitter : @clem_bouillier Membre actif des groupes suivants > DevLyon : groupe de développeurs partageant une vision de l’informatique créant de la valeur  http://devlyon.fr > MUG Lyon : groupe de passionnés de technologies en environnement Microsoft sur Lyon > Fier d’être développeur : groupe visant à promouvoir le métier de développeur en France  http://fierdetredeveloppeur.org/

La documentation, c’est un peu comme la qualité… (…tout le monde en parle, très peu en font…)

…on vous explique les processus à suivre pour y arriver (ou pas!) Exemples typiques : Qualité = spécifications exhaustives, plans de tests, usine de tests manuels… Documentation = spécifications exhaustives upfront, code commenté, wiki après avoir codé… Tout ça au bon moment dans le cycle projet évidemment !

…et pourtant le résultat est régulièrement le même…

Qualité en apparence (pour le client, à la « recette »)  Aller vers la QUALITE INTRINSEQUE Documentation désynchronisée de la réalité (voire le néant)  Aller vers la DOCUMENTATION INTRINSEQUE

Qualité et documentation intrinsèque vont de pair Ne demande pas d’activités spécialisées ayant un autre but que : « Produire un logiciel opérationnel PLUS QU’une documentation exhaustive »

1. Documentation fonctionnelle

Développement piloté par l’expérience utilisateur  User Story

…inspirez-vous du Story Mapping…«understanding what your whole system is intended to do » - Jeff Patton

…puis outillez légèrement Conserver les éléments notés autour des User Story lors de la réalisation (1 User Story = 3C : carte, conversation, confirmation) + Regrouper les User Story par Theme/Activité fonctionnel(le) + Gérer les User Story obsolètes (suppression/évolutions) + Taches… + Test Cases…

…et documenter avec une démarche BDD Piloter vos développements par la description du comportement métier désiré « Conversation » et « confirmation » (cf. 3C) sont intimement liés Le code est fonctionnellement lié à la User Story

2. Documentation technique

Code explicite PLUS QUE code commenté Eviter les commentaires quand vous pouvez expliciter la même chose dans le code Reprenez les termes métiers dans votre code /! aux abstractions et aux APIs : à documenter (JavaDoc…) // check to see if employee is eligible for full benefits if ((employee.flags & HOURLY_FLAG) && employee.age > 65) if (employee.isEligibleForFullBenefits()) Chapitre 4 de Clean Code – Uncle Bob

TDD = Test Driven Development, mais aussi DESIGN (= conception) Conception incrémentale PLUS QUE « upfront » + Documentation des intentions plus que la structure + BONUS : tests automatisés  non-régression

Et en complément… Commentaires de commit propres (liés au User Story en BONUS) + Un wiki pour documenter 1. les pratiques de l’équipe 2. les exigences transverses

Toutes ces pratiques portent la documentation = Documentation intrinsèque User Story/Story Mapping BDD TDD Code explicite PLUS QUE des processus de documentation complémentaires Vous ne les connaissez pas ? Etudiez, entrainez-vous au plus vite…

MERCI QUESTIONS ? ROTI ?

Add a comment

Related presentations

Related pages

Lyon - Mardi 11 mars 2014 | Human Talks

Human Talks. Les Talks Guide du ... Lyon Mardi 11 mars 2014 à 19h. Les talks. Documentation intrinsèque. par Clément Bouillier. C++ et Web: la croisée ...
Read more

Promoting Motivation, Health, and Excellence: Ed Deci at ...

... Founder of Self-Determination Theory Ed will describe two common forms of motivation ... for human excellence: Mike ... TEDx Talks 206,040 ...
Read more

Dan Pink: The puzzle of motivation | TED Talk | TED.com

The puzzle of motivation ... This talk was presented at an official TED conference, ... Human trafficking is all around you.
Read more

The IT Crowd’s Katherine Parkinson endorses U.S. remake ...

... about a society in which humanoid assistants called Synths develop human traits. ... In an age of self-documentation and tech-validation, ... talks ...
Read more

Clay Shirky: How social media can make history | TED Talk ...

How social media can make history ... If you want to get even more from TED, like the ability to save talks to watch later, sign up for a TED account now.
Read more

Documentation - VideoLAN - VLC: Official site - Free ...

Some VLC documentation is available on the VideoLAN wiki's ... VLC media player and x264 are trademarks internationally registered by the VideoLAN ...
Read more