Session 5.2 – Project Documentation

Module 5: Publishing & Documentation | Duration: 2 hrs

Learning Objectives
  • Write a concise "Read Me" file explaining your project.
  • Document the prompt strategy used to create the app.

The README

Good software has good documentation. Include: Project Title, Problem Solved, Target Audience, and a "How to Use" section.

User Guide

Write a 3-step guide for new users. "1. Create Account. 2. Upload file. 3. See analysis."

Session Summary

Documentation checks your understanding. If you can't explain it simply, you don't understand it well enough.