C++ · Advanced level

Advanced level · Module 6: C++ Capstone Project · Lesson 5 of 5

Documentation and Presentation

Write the README and usage documentation, and present the capstone with a live demonstration.

In this lesson you will

  • Write documentation that lets others build and use the tool
  • Present the project with evidence of quality

Key concepts

READMEusage examplesdemonstrationreflection

The lesson

The README covers what the tool does, how to build it with CMake, how to run it with examples, the input format and how to run the tests and benchmarks. Have a classmate build and run it using only the README.

Document limitations honestly, such as unsupported formats or known performance limits. Users trust tools whose limits are stated.

In the presentation, run the tool on realistic data, show error handling on a malformed file, run the tests and show the benchmark. Explain one design decision and what you would improve next.

Step by step

  1. Write the README and usage examples.
  2. Have a classmate follow the README.
  3. Prepare the demonstration data and script.
  4. Rehearse with a timer.

Practice activity

Complete milestone 5 and present the Offline Sensor Data Processor.

Expected result: A classmate can build and run the tool from the README, and the presentation shows correctness, robustness and performance evidence.

Check your understanding

  1. Why document limitations?

    Show answer

    So users know what the tool does not support and can trust what it claims.

  2. What should the demonstration show besides normal output?

    Show answer

    Error handling, the tests and the performance evidence.

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.