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>

<code> RULES!!!</code>

The M in RTFM : When Code is not Enough

CS2103/T, Lecture 7, Part 2, [Oct 3, 2014]

Developer-to-developer docs

The M in RTFM : When Code is not Enough

Developer-to-developer docs

Developer-to-developer docs

Developer-to-developer docs

for developer as user

for developer as maintainer

Developer-to-developer docs

for developer as user

for developer as maintainer

Developer-to-developer docs

for developer as user

for developer as maintainer

Do Don’t

Do

Do Don’t

Do Don’t

Do Don’t

Just enough docs As much docs as possible

Top-down Bottom up

300,000+ LoC (Lines of Code)700+ 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

Remember the purpose

So, how many class diagrams

to include?

Comprehensible Comprehensive

Docs from code White elephants

Top-down Bottom up

Just enough docs As much docs as possible

Remember the purpose

What does STFW (a cousin of RTFM) stands for?

stands {answer}

e.g. stands see the fine wife

77577 OR tinyurl.com/answerpost

GIYFLMGTFY