Warning
Download
1 / 34

WARNING - PowerPoint PPT Presentation


  • 126 Views
  • Uploaded on

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 .

loader
I am the owner, or an agent authorized to act on behalf of the owner, of the copyrighted work described.
capcha
Download Presentation

PowerPoint Slideshow about ' WARNING' - deiondre


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.While downloading, if for some reason you are not able to download a presentation, the publisher may have deleted the file from their server.


- - - - - - - - - - - - - - - - - - - - - - - - - - E N D - - - - - - - - - - - - - - - - - - - - - - - - - -
Presentation Transcript
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.

  • These slides contain a lot of animations. For optimal results, watch in slideshow mode.



<code> RULES!!!</code>


The M in RTFM : When Code is not Enough

CS2103/T, Lecture 7, Part 2, [Oct 4, 2013]


The M in RTFM : When Code is not Enough

Developer-to-developer docs




Developer to developer docs
Developer-to-developer docs

  • fordeveloper as user

fordeveloper as maintainer


Developer to developer docs1
Developer-to-developer docs

  • fordeveloper as user

fordeveloper as maintainer


Developer to developer docs2
Developer-to-developer docs

  • fordeveloper as user

fordeveloper as maintainer


Just enough docs

As much docs as possible


Top-down

Bottom up


75,000+LoC

300+ source files

1 week to start coding


Docs from code

White elephants


Docs from code

White elephants


Comprehensible

Comprehensive

Use cases

Class diagrams

Sequence diagrams



Remember the purpose

So, how many class diagrams to include?


Just enough docs

As much docs as possible

Top-down

Bottom up

Docs from code

White elephants

Comprehensible

Comprehensive

Remember the purpose


What does rtfm stands for
What does RTFM stands for?

stands {answer}

e.g. stands raise the fine money

77577


ad