Python · Advanced level

Advanced level · Module 6: Python Capstone: Deploying a Real Application · Lesson 5 of 5

Documentation, Handover and Presentation

Document the application for users and maintainers and present it to stakeholders.

In this lesson you will

  • Write user and maintainer documentation
  • Present a technical project to a non-technical audience

Key concepts

user guidemaintainer guidedemo scriptsupport plan

The lesson

Two audiences need documentation: users, who need to know how to use the system, and maintainers, who need to know how to install, configure and change it.

A user guide uses plain language and screenshots for the main tasks. A maintainer README covers set-up, configuration, how to run tests and where the data is stored.

The final presentation explains the problem, shows the working solution, presents evidence of testing and states honestly what remains to do.

Step by step

  1. Write the user guide for the three main tasks.
  2. Write the maintainer README.
  3. Prepare a 10-minute presentation with a live demonstration.
  4. Rehearse and prepare for panel questions.

Practice activity

Deliver your capstone with a user guide, maintainer README and a 10-minute presentation to a panel.

Expected result: Complete documentation and a confident presentation.

Check your understanding

  1. What should come first in a presentation to a non-technical client?

    Show answer

    The problem the system solves and how it helps them.

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.