Cyrille Martraire: Living Documentation Jumpstart at I T.A.K.E. Unconference 2015
•
3 gostaram•1,403 visualizações
Cyrille Martraire: Living Documentation Jumpstart at I T.A.K.E. Unconference 2015
Recomendados
Recomendados
Mais conteúdo relacionado
Semelhante a Cyrille Martraire: Living Documentation Jumpstart at I T.A.K.E. Unconference 2015
Semelhante a Cyrille Martraire: Living Documentation Jumpstart at I T.A.K.E. Unconference 2015 (20)
Mais de Mozaic Works
Mais de Mozaic Works (20)
Último
Último (20)
Cyrille Martraire: Living Documentation Jumpstart at I T.A.K.E. Unconference 2015
- 2. What do you expect?
- 4. And could improve your code too?
- 5. a source of frustration
- 8. we can do better…
- 9. much better Good Documentation also leads to better Design
- 10. Workshop
- 11. An existing Java project (from the USB drive) ! ☞ Explore, Change, Learn
- 16. Documentation
- 19. USING MS OFFICE
- 20. *NOT* CODING
- 21. We love executable stuff
- 25. I don’t want to maintain documentation !
- 27. If we adopt a new mindset
- 31. Passing Knowledge to other people Transmission
- 32. Passing Knowledge to other people Making Accessible
- 33. Passing Knowledge for the future Memory
- 34. Passing Knowledge for the future Compliance
- 38. DOCUMENTATION Because we can often do better than documentation NO
- 41. DOCUMENTATION Capitalize on the knowledge that’s already there + a little bit more NO
- 44. Workshop Now!
- 47. *Shamelessly stolen from the nicely presented competitor Fleetio Fleet Management solution* [Fleetio](https://www.fleetio.com/fuel-cards) ! # Project Phenix (Fuel Card Integration) ! Project Manager: Andrea Willeave ! ## Syncs daily Transaction data from the pump is automatically sent to Fleetio. No more manual entry of fuel receipts or downloading and importing fuel transactions across systems. ! ## Fuel Card Transaction Monitoring Transaction data from the pump are verified automatically against various rules to detect potential frauds: gas leakage, transactions too far from the vehicle etc. ! *The class responsible for that is called FuelCardMonitoring. Anomalies are detected if the vehicle is further than 300m away from the gas station, of if the transaction quantity exceeds the vehicle tank size by more than 5%* ! ## Odometer readings When drivers enter mileage at the pump, Fleetio uses that information to trigger service reminders. This time-saving approach helps you stay on top of maintenance and keeps your vehicles performing their best. ! *This module is to be launched in February 2015. Please contact us for more details.* ! ## Smart fuel management MPG and cost-per-mile are automatically calculated. Analyze your fuel spend from all angles - by vehicle, location, vehicle type, time frame. ! ! ## Customers Words
- 49. *Shamelessly stolen from the nicely presented competitor Fleetio Fleet Management solution* [Fleetio](https://www.fleetio.com/fuel-cards) ! # Project Phenix (Fuel Card Integration) ! Project Manager: Andrea Willeave ! ## Syncs daily Transaction data from the pump is automatically sent to Fleetio. No more manual entry of fuel receipts or downloading and importing fuel transactions across systems. ! ## Fuel Card Transaction Monitoring Transaction data from the pump are verified automatically against various rules to detect potential frauds: gas leakage, transactions too far from the vehicle etc. ! *The class responsible for that is called FuelCardMonitoring. Anomalies are detected if the vehicle is further than 300m away from the gas station, of if the transaction quantity exceeds the vehicle tank size by more than 5%* ! ## Odometer readings When drivers enter mileage at the pump, Fleetio uses that information to trigger service reminders. This time-saving approach helps you stay on top of maintenance and keeps your vehicles performing their best. ! *This module is to be launched in February 2015. Please contact us for more details.* ! ## Smart fuel management MPG and cost-per-mile are automatically calculated. Analyze your fuel spend from all angles - by vehicle, location, vehicle type, time frame. ! ! ## Customers Words
- 54. Word Cloud 3
- 56. 56 What is this app about?
- 57. You do it wrong!
- 60. Word Cloud: fuel card monitoring + Compare
- 63. How do I represent the Ubiquitous Language in practice?
- 64. Annotate domain-relevant classes Source code as reference
- 65. Living Glossary Living Glossary Processor Source Code & Annotations Living Glossary always up-to-date
- 66. Run the Living Glossary
- 67. Custom Doclet to export Living Glossary
- 69. Core Concepts
- 70. Class comment
- 71. ANOTHER EXAMPLE Sent directly to end customers every week
- 72. Run the Living Glossary Make changes to the code rename move to /infra remove annotations change comments
- 74. Code
- 77. Annotations
- 78. Bounded Contexts
- 83. Embedded Learning Learn on the job
- 84. LIVING DIAGRAM 4
- 85. Run the Living Diagram
- 86. Living Diagram Living Diagram Processor Source Code Living Diagram always up-to-date
- 87. Run the Living Diagram Make changes to the code Run the Living Diagram
- 89. Domain Model inside Infrastructure Outside
- 90. Design is already there
- 91. Design is already there Implicitly
- 92. Just rely on documented naming conventions
- 94. Living Diagram Living Diagram Processor Source Code Living Diagram always up-to-date
- 95. 95 tada!
- 99. No Value
- 101. 1 Diagram 1 Purpose
- 104. Fix the code Run the Living Diagram
- 106. OOPS!
- 107. Reality Check
- 108. https://www.structurizr.com/ by Simon Brown
- 111. Hard to do the Living Glossary? A signal!
- 112. Hard to do the Living Diagrams? A signal!
- 115. Know what you’re doing -> Already half-documented
- 116. ANYBODY CAN ! APPRECIATE! IT’S A MESS
- 117. PRESSURE TO ! IMPROVE DESIGN
- 118. Simpler Design Less documentation needed
- 119. More standard Less documentation needed ! fogus @fogus
- 120. Fix your workflow Write code Write tests Write doc Write tests = write doc Write code = write doc From Mikko Ohtamaa
- 121. COOL!
- 122. In Closing
- 126. Boring Documentation is dead Long Live Living Documentation!
- 127. Not about particular techniques ! Reconsider dealing with the knowledge
- 128. Share Your Ideas & Experiments
- 130. Questions? Did you try similar things too? Let’s discuss! @cyriux
- 131. Follow me @cyriux ! Slides: slideshare.net/cyriux Blog: cyrille.martraire.com ! In Paris? Join !
- 132. Merci