Python · Beginner level

Beginner level · Module 5: Python Beginner Project Studio · Lesson 3 of 3

Documenting and Presenting Your Program

Write a short README and give a clear demonstration of how the program works and how the code is organised.

In this lesson you will

  • Write a README with purpose, how to run and an example
  • Explain code structure to a non-programmer and to a programmer

Key concepts

READMEexample runcode walkthrough

The lesson

A README is the first thing another person reads about your program. It should say what the program does, how to run it, an example of input and output, and any known limitations.

Comments explain why code does something unusual; they should not repeat what the code obviously does. Clear names often make comments unnecessary.

A short demonstration shows that the program works and that you understand it. Plan it: state the problem, run a normal case, run an edge case, and be ready to explain one function.

Step by step

  1. Write a README with purpose, how to run, example and limitations.
  2. Review comments and remove any that repeat the code.
  3. Rehearse a three-minute demonstration with a timer.
  4. Prepare answers to two likely questions.

Practice activity

Present your Shop Sales Calculator in a 3-minute demonstration followed by 2 minutes of questions.

Expected result: A README submitted with your project and a demonstration finished within the time limit.

Check your understanding

  1. What three things should every README contain at minimum?

    Show answer

    What the program does, how to run it, and an example of input and output.

Taught live by an instructor — online or in person. Free course lessons are for self-study and do not lead to a certificate — see registration options.