Class 9

Held: Wednesday, 13 September 2017

We consider documentation for your programs: Why to write documention, when to write documentation, how to write documentation. We also explore the 6P style of documentation that we use in this course.

Preliminaries

Overview

• The need for documentation
• The Six P’s - a strategy for documenting procedures
• A few additional P’s
• Practice
• Pair programming

Related Pages

• Eboard 9 (Source)

• Reading:

Updates

News / Etc.

• I will distribute answer keys for homework 3 on Thursday night. (Some of you asked for extensions until then.)
• I do not yet have my grading system up and running. When I do, I will distribute grades. Until then, I cannot.
• There’s a lot in today’s lab, so I’ll try not to do too many preliminaries.
• I should have a draft code of conduct for Friday’s class.

Upcoming Work

• Writeup for class 8 due TONIGHT at 10:30 p.m.
  • To: csc151-03-grader@grinnell.edu
  • Subject: CSC 151.03 Writeup 8 (YOUR NAMES)
• Writeup for class 9 due Friday at 10:30 p.m.
  • Exercises: TBD
  • To: csc151-03-grader@grinnell.edu
  • Subject: CSC 151.03 Writeup 9 (YOUR NAMES)
• Read: Reading data from files for Friday’s class.
• Quiz Friday
  • Documentation
  • Testing
  • Tables
• Flash cards for week 3 due TONIGHT at 8 p.m.
  • To: csc-151-03-grader@grinnell.edu
  • Subject: CSC 151.03 Flash Cards Week 3 (YOUR NAME)
• Exam 1 distributed
  • Prologue due Friday night
  • Exam due Tuesday night
  • Epilogue due Wednesday night

Extra credit (Academic)

• CS Extras, Thursday at 4:15 p.m. in 3821: Caldron: A UI for CRNs.

Extra credit (Peer)

• Men’s Soccer vs. Buena Vista, Sept. 17 at 2:00 p.m.

Extra Credit (Misc)

None at the moment.

Other Good Things

• Women in Computing, TONIGHT at 7:00 p.m. in the CS commons.