Décrire son projet php dans des rapports confoo 2011
0 j'aime928 vues
Ce document est un rapport détaillant un projet PHP présenté lors de ConFoo 2011 à Montréal, abordant l'importance de la documentation dans le développement. Il traite des conventions de code, de la sécurité, de l'urbanisme des serveurs, de la planification du travail ainsi que des outils et méthodes de documentation. L'accent est mis sur l'automatisation et l'évolution des documents pour optimiser la productivité des équipes de développement.
Décrire son projet php dans des rapports confoo 2011
- 1. Décrire un projet PHP dans des rapports Confoo 2011, Montréal, Québec, Canada 9 mars 2011 mercredi 9 mars 2011
- 2. Agenda Pourquoi il faut tout rapporter? Sujets et contenus Outils et méthodes mercredi 9 mars 2011
- 3. Qui parle? Damien Seguy Consultant chez Alter Way Consulting Alter Way Group Industrialisation des développements PHP [email protected] mercredi 9 mars 2011
- 4. Yes, we take questions mercredi 9 mars 2011
- 5. mercredi 9 mars 2011
- 6. Pourquoi ? J’ai juste à me lever pour poser la question C’est pénible à écrire Personne ne le lit On est plus productif à coder C’est obsolète dès que c’est écrit On a pas le temps de le faire Ca ralentit le rythme de travail mercredi 9 mars 2011
- 7. Exemples Conventions de code Référentiel de sécurité Plan d’urbanisme Planning de travail La conception mercredi 9 mars 2011
- 8. Conventions de code Objectif : coder de manière uniforme Contenu : liste de règles à appliquer mercredi 9 mars 2011
- 9. Sommaire Liste de toutes les règles Détails de chaque règle Conventions de références PEAR, Symfony, ZF, ... mercredi 9 mars 2011
- 10. Section Nom de la règle Description littérale Exemples et non-exemples Obligatoire, recommandation, bonne pratique mercredi 9 mars 2011
- 11. Outils PHP_CodeSniffer + développement spécifique Séances de corrections du code mercredi 9 mars 2011
- 12. Récapitulatif Procéder par liste Procéder par exemple Donnez des noms Intégrez le document dans le quotidien mercredi 9 mars 2011
- 13. Référentiel de sécurité Objectif : maîtriser la sécurité Contenu : montrer qu’on sait préparer l’application à affronter les menaces de sécurité mercredi 9 mars 2011
- 14. Sommaire Rappel métier et objectifs de sécurité Le référentiel : OWASP, PCI, HIPAA, Basel II Liste des menaces identifiées Détails des protections pour chaque menace Cahier de recette mercredi 9 mars 2011
- 15. Détails des protections Nom de la règle Description de la menace et conséquence Explication du mécanisme de protection Exemples et illustration des mauvaises pratiques Méthode de validation mercredi 9 mars 2011
- 16. Récapitulatif Exploitez les référentiels Ou un gourou / expert Capitalisez par l’exemple mercredi 9 mars 2011
- 17. Plan d’urbanisme Dossier d’exploitation, architecture serveurs... Objectif : décrire les machines de production Contenu : décrire la plate-forme d’hébergement de l’application mercredi 9 mars 2011
- 18. Sommaire Schéma du réseau Liste des services de chaque serveur Flux de données entre les serveurs, par service Déploiement Procédés d’administration Installation, déploiement, redémarrage après crash mercredi 9 mars 2011
- 19. Outils Schéma Visio, Dia, Omnigraffle, Xmind Tableaux mercredi 9 mars 2011
- 20. Récapitulatif Document commun : doit être partagé, évolutif Utiliser des schémas mercredi 9 mars 2011
- 21. Planning de travail Objectif : organiser l’action dans le temps Contenu : liste des points clés du projet mercredi 9 mars 2011
- 22. Structure Planning du projet Liste de tâches et réunions Liste des cycles de travail Découpage hebdomadaire mercredi 9 mars 2011
- 23. Réunions Point projet Réunion technique Daily scrum Revue de cycle mercredi 9 mars 2011
- 24. Taches Audits croisés Tests Relecture de code Validation avant commit du jour Mise en Production mercredi 9 mars 2011
- 25. Détails des activités Nom de l’activité Fréquence Durée : % et durée effective Acteurs Sujets abordés Résultats attendus mercredi 9 mars 2011
- 26. Occupation 10 % 10 % 10 % 50 % 20 % Dev Tests Rapports Qualité MeP mercredi 9 mars 2011
- 27. Outils Calendrier Diagrammes de Gantt mercredi 9 mars 2011
- 28. Document de conception Objectif : rassembler tout ce qui contribue à la progression du projet Structure : dictionnaire des concepts mercredi 9 mars 2011
- 29. Sommaire Objectifs de l’application Glossaire Procédés particuliers Liste de noms mercredi 9 mars 2011
- 30. Objectifs de l’application Rappel des objectifs métier Donne une vision d’ensemble Liste les cas d’utilisation mercredi 9 mars 2011
- 31. Glossaire Dictionnaire des termes utilisés Sigles Termes métier Synonymes Donner des illustrations mercredi 9 mars 2011
- 32. Procédés particuliers Explications des algorithmes Schéma rapide du fonctionnement Exemples d’application mercredi 9 mars 2011
- 33. Listes de noms Tout ce qui est nommé doit être listé Classes, méthodes, propriétés, constantes, fonctions, sessions URL, vues, contrôleurs, cookies, modules Nom des tables, bases de données, serveurs, configurations Formats de noms, de fichiers mercredi 9 mars 2011
- 34. Listes de noms Classes : diagrammes de classes, de paquets Tables : MCD Le reste : des tableaux en traitement de texte mercredi 9 mars 2011
- 35. Outils Diagrammes de classes ArgoUML, StarUML MCD Mysql Workbench, Power Architect Traitement de texte Format extractible, vérifiable mercredi 9 mars 2011
- 36. Récapitulatif Savoir vérifier l’application de la conception Savoir faire évoluer la conception au besoin Beaucoup d’outils Faites un choix mercredi 9 mars 2011
- 37. Parce que! Je suis autonome Je participe à sa rédaction Je l’utilise régulièrement Je me pose moins de questions Je peux le tester facilement Je le fait depuis le début mercredi 9 mars 2011
- 38. L’impact est croissant mercredi 9 mars 2011
- 39. http://www.slideshare.net/alterway/ [email protected] mercredi 9 mars 2011
- 40. mercredi 9 mars 2011
- 41. Outils Détecteurs automatiques Auditeurs statiques Revue manuelle Audits croisés Ajouter une fiche de recette mercredi 9 mars 2011
- 42. Tout le monde aime ça Graphiques, camemberts, courbes... Tableaux Prévisions, constatations mercredi 9 mars 2011
- 43. Pour qui? Clients / Développeurs utilisateurs Projet Chef de Administrateurs projet mercredi 9 mars 2011
- 44. Personne n’aime les écrire Documentations cul-de-sac Temps perdu Jamais lu Tout le monde se plaint de ne jamais en avoir mercredi 9 mars 2011
- 45. Une activité complète Prendre les informations Les rédiger Les relire Les valider Les faire comprendre mercredi 9 mars 2011
- 46. Pilotage à vue Est-ce que c’est fait? Est-ce que c’est en retard? Qu’est-ce qu’il y a dedans On vire une partie, on en garde une autre On recommence mercredi 9 mars 2011
- 47. Les développeurs Les clients et utilisateurs Le chef de projet Les administrateurs mercredi 9 mars 2011
- 48. Comment documenter? Établir un document texte, tableur Le partager entre les intervenants En lecture seule pour les autres Automatiser la vérification du document mercredi 9 mars 2011
- 49. Dans le doute? Forcez sur les exemples Arrangez-vous pour que le document soit éditable Dégagez explicitement du temps pour lire des documents, les écrire, les relire, les appliquer. mercredi 9 mars 2011
- 50. Spécifications et tests Si personne ne les écrits, vous êtes dans la merde Principe de la loi de Murphy : on oublie tout ce qui va, et on ne fait le bilan que de ce qui ne va pas. Le temps de l’écrire, vous le comprenez, et vous temporisez face au client. Apaisement du cycle de développement mercredi 9 mars 2011
- 51. Spécifications Evitez le futur (utilisez le présent) Fuyez les listes non terminées (privilégiez les listes finies, quitte à reporter en annexe des ajouts finaux, tbd) Donnez des noms à tout, et mettez en glossaire Explicitez ce qui ne l’est pas Faites des tableaux dès que possible mercredi 9 mars 2011
- 52. Urbanisation des serveurs Les machines qui supportent l’application Les services et les flux de données Les accès et/ou les responsables Les procédures à appliquer deploiement, installation, restauration, crash, sécurité, sauvegarde mercredi 9 mars 2011
- 53. mercredi 9 mars 2011
- 54. Evitez les réducteurs Peut, pourrais petit, léger, rapide, simple, light beta, version x.xx.01 mercredi 9 mars 2011