1 / 34

WARNING

WARNING. These slides are not optimized for printing or exam preparation. These are for lecture delivery only. These slides are made for PowerPoint 2010. They may not show up well on other PowerPoint versions . You can download PowerPoint 2010 viewer from here .

deiondre
Download Presentation

WARNING

An Image/Link below is provided (as is) to download presentation Download Policy: Content on the Website is provided to you AS IS for your information and personal use and may not be sold / licensed / shared on other websites without getting consent from its author. Content is provided to you AS IS for your information and personal use only. Download presentation by click this link. While downloading, if for some reason you are not able to download a presentation, the publisher may have deleted the file from their server. During download, if you can't get a presentation, the file might be deleted by the publisher.

E N D

Presentation Transcript

  1. WARNING • These slides are not optimized for printing or exam preparation. These are for lecture delivery only. • These slides are made for PowerPoint 2010. They may not show up well on other PowerPoint versions. You can download PowerPoint 2010 viewer from here. • These slides contain a lot of animations. For optimal results, watch in slideshow mode.

  2. <code> RULES!!!</code>

  3. <code> RULES!!!</code>

  4. The M in RTFM : When Code is not Enough CS2103/T, Lecture 7, Part 2, [Oct 4, 2013]

  5. The M in RTFM : When Code is not Enough Developer-to-developer docs

  6. Developer-to-developer docs

  7. Developer-to-developer docs

  8. Developer-to-developer docs • fordeveloper as user fordeveloper as maintainer

  9. Developer-to-developer docs • fordeveloper as user fordeveloper as maintainer

  10. Developer-to-developer docs • fordeveloper as user fordeveloper as maintainer

  11. Just enough docs As much docs as possible

  12. Top-down Bottom up

  13. 75,000+LoC 300+ source files 1 week to start coding

  14. Docs from code White elephants

  15. Docs from code White elephants

  16. Comprehensible Comprehensive Use cases Class diagrams Sequence diagrams

  17. Remember the purpose

  18. Remember the purpose So, how many class diagrams to include?

  19. Just enough docs As much docs as possible Top-down Bottom up Docs from code White elephants Comprehensible Comprehensive Remember the purpose

  20. What does RTFM stands for? stands {answer} e.g. stands raise the fine money 77577

More Related