1 / 36

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 .

roman
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 3, 2014]

  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. Do Don’t Do Don’t Do Don’t Do Don’t Do

  12. Just enough docs As much docs as possible

  13. Top-down Bottom up

  14. 300,000+LoC (Lines of Code) 700+ source files 1 week to start coding

  15. Docs from code White elephants

  16. Docs from code White elephants

  17. Comprehensible Comprehensive Use cases Class diagrams Sequence diagrams

  18. Remember the purpose

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

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

  21. What does STFW (a cousin of RTFM) stands for? GIYF LMGTFY stands {answer} e.g. stands see the fine wife 77577OR tinyurl.com/answerpost

More Related