Advanced level · Module 6: Java Capstone Project · Lesson 5 of 5
Documentation and Presentation
Write a README and API documentation others can follow, and present the project with a live demonstration.
In this lesson you will
- Write a README with setup, run, test and API usage instructions
- Present the project and answer design questions
Key concepts
READMEAPI documentationdemo scriptreflection
The lesson
A README is the front door of a project. Include what it does, requirements (JDK version, database), how to configure, run and test it, and example requests. Ask a classmate to follow it on their own machine; every question they ask is a gap to fix.
Document the API with the contract's examples, updated to match the final implementation. Tools can generate interactive documentation, but clear examples are what users read first.
In the presentation, show a realistic scenario end to end, demonstrate an error being handled, run the tests and explain one decision and one thing you would do differently. Keep to the time limit.
Step by step
- Write the README and have a classmate follow it.
- Update the API documentation to match the code.
- Prepare a five-minute demo script.
- Rehearse the presentation once with a timer.
Practice activity
Complete milestone 5 and present the Clinic Appointment REST Service.
Expected result: A classmate can run the project from the README alone, and the presentation covers the scenario, an error case, tests and reflection.
Check your understanding
-
What is the best test of a README?
Show answer
Someone else follows it on their own machine without help.
-
What should a capstone presentation include besides the happy path?
Show answer
An error being handled, the tests running and an explanation of design decisions.
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.