Your documentation is complete when someone can use your module without ever having to look at its code. This is very important. This makes it possible for you to separate your module’s documented interface from its internal implementation (guts). This is good because it means that you are free to change the module’s internals as long as the interface remains the same.
Remember: the documentation, not the code, defines what a module does.
Computer Problems by @xkcd.
We’d like to make this course better, much better, and we’re super interested in what you think of this course! You’d help us enormously by filling out this survey. It should take about 15 minutes and it can be filled in completely anonymous.
There are no assignments due next week (or any future week). You can continue working on your prototype for the final assesment.
Make sure you come to the lab prepared in advance:
- Know which questions you want to ask.
- If you have a bug, investigate and try to make a detailed explanation of your problem.
- Ask other students if they encountered the same problem.
We'll do a live demo or recap a specific topic from previous lessons.
During these classes we'll also be reviewing each others code. Make sure you made progress so you have something to get feedback on.
- Stuck? See the Bugs section of the course readme to find a list of troubleshooting tips
- How to think like a programmer by Richard Reis
- Rubber Duck Debugging
Next week assessment 2 will take place. Make sure you come to the assesment prepared in advance:
- Have a look at the rubic and grade yourself. Bring the filled in rubic to the oral test.
- Check out the checklist below the rubic. Did you forget anything?
Presenting your work is a skill all by itself, make sure you prepare yourself properly. The best way is to treat it as public speaking and there are many books on public speaking available.
- Bring your own computer and a charger.
- Have the latest version of your code ready in your editor.
- Open up your docs inside of your GitHub repository.
- Have a live version up and running.