Documentation: user and technical
Computer Studies · Grade 10 · about 40 minutes
Two audiences. Written beside every stage, not after. Comments are technical docs inside the code.
Sign in to read this lesson
Lessons are for learners and teachers with an account. Browsing the curriculum — subjects, strands and what each sub-strand covers — stays open to everyone.
- 8 sections of explanation, worked examples and diagrams
- 1 practice task with hints and worked answers
- A quiz that marks itself as you go
- Your progress kept across every subject you take
Other lessons in this sub-strand
- The program development cycle and algorithms
- Pseudocode and flowcharts
- The essence of the program development cycle
- Problem definition: what must it do?
- Program design: how will it work?
- Coding: spelling the design in a language
- Testing and debugging
- Implementation: putting it into real use
- Maintenance: most of the life of a program
- Documentation: user and technical
- Characteristics of a good algorithm
- Sequence, selection and iteration
- Dry runs and trace tables
- Designing an algorithm for a real problem
- From kiosk problem to maintained code