0
FooLab             ERD, Flowcharts and             Other Documentation             Northeast PHP Conference - August 11, 2...
What It’s Not About                       FooLab        • Not a full analysis and design course        • Not a demo of mod...
What It Is About                     FooLab        • What diagrams serve what purpose        • Tie diagrams together      ...
Anna Filina                       FooLab        • PHP Quebec - user group        • ConFoo - non for profit Web             ...
Why No Docs?                  FooLab        • Dont know where to begin        • Its boring        • There’s no point      ...
The Real Problem                           FooLab        • Dont understand diagrams        • Diagrams serve no purpose, no...
FooLab             Conference             Management SoftwareSaturday, August 11, 2012
Use Case                FooLab                            8Saturday, August 11, 2012
ER Diagram              FooLab                            9Saturday, August 11, 2012
ER Diagram                              FooLab                            1   0 or more                                 (m...
ER Diagram               FooLab                            10Saturday, August 11, 2012
ER Diagram                                 FooLab                              Identifying                            Non-...
ER Diagram               FooLab                            11Saturday, August 11, 2012
Data Flow Diagram        FooLab                            12Saturday, August 11, 2012
Data Flow Diagram          FooLab            External entity                              12Saturday, August 11, 2012
Data Flow Diagram          FooLab            External entity                              12Saturday, August 11, 2012
Data Flow Diagram          FooLab            External entity                              12Saturday, August 11, 2012
Data Flow Diagram        FooLab                            13Saturday, August 11, 2012
Data Flow Diagram                     FooLab                            1 2    3 4        5 6                             ...
Data Flow Diagram        FooLab                            14Saturday, August 11, 2012
Common Mistakes                  FooLab        • Data not stored.        • Black hole.        • Grey hole.        • Sponta...
Flowchart                FooLab                            16Saturday, August 11, 2012
Flowchart                        FooLab                            Input                                    Output        ...
Mockups                  FooLab                            17Saturday, August 11, 2012
Mockups                  FooLab                            18Saturday, August 11, 2012
Function Reference                           FooLab        • Session              • bool isSelected()              • void ...
Source Comments                                  FooLab              • Inline comments // simple and short explanations   ...
FooLab             Putting it all together             A.K.A. “The Manual”Saturday, August 11, 2012
Manual                                 FooLab        •     Define chapters. Example:              1. Scope (Use Cases)     ...
Manual                                FooLab        • Write topics in bullet point        • Add diagrams        • Write pa...
FooLab             How much to write?Saturday, August 11, 2012
Application Complexity                FooLab                            Grandma’s                                         ...
Application Complexity                FooLab                            Grandma’s                                         ...
Security Requirements                  FooLab                            Grandma’s           IAFIS                        ...
Security Requirements                  FooLab                            Grandma’s           IAFIS                        ...
Financial Impact                      FooLab                                                Forex                         ...
Financial Impact                      FooLab                                                Forex                         ...
Team Size                            FooLab                            Yourself    vs   20 devs                           ...
Team Size                            FooLab                            Yourself    vs   20 devs                        Les...
Team Proximity                    FooLab                            Same                                     vs   Remote  ...
Team Proximity                     FooLab                             Same                                      vs   Remot...
Good Documentation                       FooLab        • Makes your software easier to build and maintain        • Makes y...
FooLab     Mind MapsSaturday, August 11, 2012
FooLab             Systems Analysis and             Design and/or UML bookSaturday, August 11, 2012
Next Steps                        FooLab        • I will tweet the slides:              @afilina        • Please leave feed...
FooLab        Ask me which software        I use.Saturday, August 11, 2012
FooLab        Ask me which software        I use.                            astah, BalsamiqSaturday, August 11, 2012
Upcoming SlideShare
Loading in...5
×

ERD, Flowcharts and Other Documentation

2,170

Published on

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.

Published in: Technology, Business
0 Comments
1 Like
Statistics
Notes
  • Be the first to comment

No Downloads
Views
Total Views
2,170
On Slideshare
0
From Embeds
0
Number of Embeds
1
Actions
Shares
0
Downloads
59
Comments
0
Likes
1
Embeds 0
No embeds

No notes for slide

Transcript of "ERD, Flowcharts and Other Documentation"

  1. 1. FooLab ERD, Flowcharts and Other Documentation Northeast PHP Conference - August 11, 2012Saturday, August 11, 2012
  2. 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. 3. What It Is About FooLab • What diagrams serve what purpose • Tie diagrams together • Real world examples • More examples 3Saturday, August 11, 2012
  4. 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. 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. 6. The Real Problem FooLab • Dont understand diagrams • Diagrams serve no purpose, not helpful • Inadequate tools 6Saturday, August 11, 2012
  7. 7. FooLab Conference Management SoftwareSaturday, August 11, 2012
  8. 8. Use Case FooLab 8Saturday, August 11, 2012
  9. 9. ER Diagram FooLab 9Saturday, August 11, 2012
  10. 10. ER Diagram FooLab 1 0 or more (many) 9Saturday, August 11, 2012
  11. 11. ER Diagram FooLab 10Saturday, August 11, 2012
  12. 12. ER Diagram FooLab Identifying Non-identifying 10Saturday, August 11, 2012
  13. 13. ER Diagram FooLab 11Saturday, August 11, 2012
  14. 14. Data Flow Diagram FooLab 12Saturday, August 11, 2012
  15. 15. Data Flow Diagram FooLab External entity 12Saturday, August 11, 2012
  16. 16. Data Flow Diagram FooLab External entity 12Saturday, August 11, 2012
  17. 17. Data Flow Diagram FooLab External entity 12Saturday, August 11, 2012
  18. 18. Data Flow Diagram FooLab 13Saturday, August 11, 2012
  19. 19. Data Flow Diagram FooLab 1 2 3 4 5 6 8 7 13Saturday, August 11, 2012
  20. 20. Data Flow Diagram FooLab 14Saturday, August 11, 2012
  21. 21. Common Mistakes FooLab • Data not stored. • Black hole. • Grey hole. • Spontaneous generation. 15Saturday, August 11, 2012
  22. 22. Flowchart FooLab 16Saturday, August 11, 2012
  23. 23. Flowchart FooLab Input Output 16Saturday, August 11, 2012
  24. 24. Mockups FooLab 17Saturday, August 11, 2012
  25. 25. Mockups FooLab 18Saturday, August 11, 2012
  26. 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. 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. 28. FooLab Putting it all together A.K.A. “The Manual”Saturday, August 11, 2012
  29. 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. 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. 31. FooLab How much to write?Saturday, August 11, 2012
  32. 32. Application Complexity FooLab Grandma’s vs Facebook recipes 25Saturday, August 11, 2012
  33. 33. Application Complexity FooLab Grandma’s vs Facebook recipes Less docs More docs 25Saturday, August 11, 2012
  34. 34. Security Requirements FooLab Grandma’s IAFIS vs recipes fingerprints 26Saturday, August 11, 2012
  35. 35. Security Requirements FooLab Grandma’s IAFIS vs recipes fingerprints Less docs More docs 26Saturday, August 11, 2012
  36. 36. Financial Impact FooLab Forex Grandma’s vs currency recipes trading 27Saturday, August 11, 2012
  37. 37. Financial Impact FooLab Forex Grandma’s vs currency recipes trading Less docs More docs 27Saturday, August 11, 2012
  38. 38. Team Size FooLab Yourself vs 20 devs 28Saturday, August 11, 2012
  39. 39. Team Size FooLab Yourself vs 20 devs Less docs More docs 28Saturday, August 11, 2012
  40. 40. Team Proximity FooLab Same vs Remote office 29Saturday, August 11, 2012
  41. 41. Team Proximity FooLab Same vs Remote office Less docs More docs 29Saturday, August 11, 2012
  42. 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. 43. FooLab Mind MapsSaturday, August 11, 2012
  44. 44. FooLab Systems Analysis and Design and/or UML bookSaturday, August 11, 2012
  45. 45. Next Steps FooLab • I will tweet the slides: @afilina • Please leave feedback: http://joind.in/6838 33Saturday, August 11, 2012
  46. 46. FooLab Ask me which software I use.Saturday, August 11, 2012
  47. 47. FooLab Ask me which software I use. astah, BalsamiqSaturday, August 11, 2012
  1. A particular slide catching your eye?

    Clipping is a handy way to collect important slides you want to go back to later.

×