ERD, Flowcharts and Other Documentation
Upcoming SlideShare
Loading in...5
×
 

Like this? Share it with your network

Share

ERD, Flowcharts and Other Documentation

on

  • 2,015 views

Documentation is much more than just commenting code. It can be a lot more fun too. Learn what types of documentation are useful, when it is appropriate to use and how to write it. Through real-world ...

Documentation is much more than just commenting code. It can be a lot more fun too. Learn what types of documentation are useful, when it is appropriate to use and how to write it. Through real-world examples, this talk will teach you how to create meaningful and helpful documentation.

Statistics

Views

Total Views
2,015
Views on SlideShare
2,015
Embed Views
0

Actions

Likes
1
Downloads
34
Comments
0

0 Embeds 0

No embeds

Accessibility

Categories

Upload Details

Uploaded via as Adobe PDF

Usage Rights

© All Rights Reserved

Report content

Flagged as inappropriate Flag as inappropriate
Flag as inappropriate

Select your reason for flagging this presentation as inappropriate.

Cancel
  • Full Name Full Name Comment goes here.
    Are you sure you want to
    Your message goes here
    Processing…
Post Comment
Edit your comment

ERD, Flowcharts and Other Documentation Presentation Transcript

  • 1. FooLab ERD, Flowcharts and Other Documentation Northeast PHP Conference - August 11, 2012Saturday, August 11, 2012
  • 2. What It’s Not About FooLab • Not a full analysis and design course • Not a demo of modeling tools • Not a detailed explanation of symbology 2Saturday, August 11, 2012
  • 3. What It Is About FooLab • What diagrams serve what purpose • Tie diagrams together • Real world examples • More examples 3Saturday, August 11, 2012
  • 4. Anna Filina FooLab • PHP Quebec - user group • ConFoo - non for profit Web conference • FooLab Inc. - IT consulting • I write code. • I train and supervise programmers. • I make recommendations. 4Saturday, August 11, 2012
  • 5. Why No Docs? FooLab • Dont know where to begin • Its boring • There’s no point • Get out of date • Nobody reads them 5Saturday, August 11, 2012
  • 6. The Real Problem FooLab • Dont understand diagrams • Diagrams serve no purpose, not helpful • Inadequate tools 6Saturday, August 11, 2012
  • 7. FooLab Conference Management SoftwareSaturday, August 11, 2012
  • 8. Use Case FooLab 8Saturday, August 11, 2012
  • 9. ER Diagram FooLab 9Saturday, August 11, 2012
  • 10. ER Diagram FooLab 1 0 or more (many) 9Saturday, August 11, 2012
  • 11. ER Diagram FooLab 10Saturday, August 11, 2012
  • 12. ER Diagram FooLab Identifying Non-identifying 10Saturday, August 11, 2012
  • 13. ER Diagram FooLab 11Saturday, August 11, 2012
  • 14. Data Flow Diagram FooLab 12Saturday, August 11, 2012
  • 15. Data Flow Diagram FooLab External entity 12Saturday, August 11, 2012
  • 16. Data Flow Diagram FooLab External entity 12Saturday, August 11, 2012
  • 17. Data Flow Diagram FooLab External entity 12Saturday, August 11, 2012
  • 18. Data Flow Diagram FooLab 13Saturday, August 11, 2012
  • 19. Data Flow Diagram FooLab 1 2 3 4 5 6 8 7 13Saturday, August 11, 2012
  • 20. Data Flow Diagram FooLab 14Saturday, August 11, 2012
  • 21. Common Mistakes FooLab • Data not stored. • Black hole. • Grey hole. • Spontaneous generation. 15Saturday, August 11, 2012
  • 22. Flowchart FooLab 16Saturday, August 11, 2012
  • 23. Flowchart FooLab Input Output 16Saturday, August 11, 2012
  • 24. Mockups FooLab 17Saturday, August 11, 2012
  • 25. Mockups FooLab 18Saturday, August 11, 2012
  • 26. Function Reference FooLab • Session • bool isSelected() • void mailConfirmation(), check logs • bool saveVote($user, $vote) • Automate tests of input/output. 19Saturday, August 11, 2012
  • 27. Source Comments FooLab • Inline comments // simple and short explanations • /** * Commonly used above functions. * Can use annotations with phpDocumentor or other. */ Descriptive blocks • Comment when it’s fresh. • Big functions with lots of comments = split function. 20Saturday, August 11, 2012
  • 28. FooLab Putting it all together A.K.A. “The Manual”Saturday, August 11, 2012
  • 29. Manual FooLab • Define chapters. Example: 1. Scope (Use Cases) 2. Database (ERD) 3. Processes (DFD + Flowchart) 4. Mockups (later screenshots) 5. Classes + usage 22Saturday, August 11, 2012
  • 30. Manual FooLab • Write topics in bullet point • Add diagrams • Write paragraph under each bullet • Move topics and chapters around • Fill in with details 23Saturday, August 11, 2012
  • 31. FooLab How much to write?Saturday, August 11, 2012
  • 32. Application Complexity FooLab Grandma’s vs Facebook recipes 25Saturday, August 11, 2012
  • 33. Application Complexity FooLab Grandma’s vs Facebook recipes Less docs More docs 25Saturday, August 11, 2012
  • 34. Security Requirements FooLab Grandma’s IAFIS vs recipes fingerprints 26Saturday, August 11, 2012
  • 35. Security Requirements FooLab Grandma’s IAFIS vs recipes fingerprints Less docs More docs 26Saturday, August 11, 2012
  • 36. Financial Impact FooLab Forex Grandma’s vs currency recipes trading 27Saturday, August 11, 2012
  • 37. Financial Impact FooLab Forex Grandma’s vs currency recipes trading Less docs More docs 27Saturday, August 11, 2012
  • 38. Team Size FooLab Yourself vs 20 devs 28Saturday, August 11, 2012
  • 39. Team Size FooLab Yourself vs 20 devs Less docs More docs 28Saturday, August 11, 2012
  • 40. Team Proximity FooLab Same vs Remote office 29Saturday, August 11, 2012
  • 41. Team Proximity FooLab Same vs Remote office Less docs More docs 29Saturday, August 11, 2012
  • 42. Good Documentation FooLab • Makes your software easier to build and maintain • Makes your team more effective • Discover new features before implementation 30Saturday, August 11, 2012
  • 43. FooLab Mind MapsSaturday, August 11, 2012
  • 44. FooLab Systems Analysis and Design and/or UML bookSaturday, August 11, 2012
  • 45. Next Steps FooLab • I will tweet the slides: @afilina • Please leave feedback: http://joind.in/6838 33Saturday, August 11, 2012
  • 46. FooLab Ask me which software I use.Saturday, August 11, 2012
  • 47. FooLab Ask me which software I use. astah, BalsamiqSaturday, August 11, 2012