Advanced
80 mins
Teacher/Student led
+130 XP
Teacher-led from the board — pupils need no device

Documenting and Packaging

In this checkpoint lesson you will document your CBA project so it can be understood and assessed by others. You will honestly note any AI tool assistance, investigate ethical or legal issues, and organise your evidence into a clean package ready for marking.

Teacher Class Feed

Load previous activity

    1 - Start ~3 mins

    Illustration for StartYour project or portfolio for your assessment task is well under way. Today is a checkpoint: you document what you have made so someone else can understand and judge it, note honestly where AI tools helped, check any ethical or legal issues, and package your evidence cleanly. You are not finishing the whole project today. You are making the work ready to be read, and ready for a partner to open and try in about 30 seconds.

    2 - Must Finish Today ~1 mins

    By the end of today you need six things done, and they build on each other. You need a short overview of your work, your plan saved alongside it, and one note about a test you ran. Then you need a note on where AI tools helped you, a note on any ethical or legal issue in your work, and all of it gathered into one package: a single folder or portfolio holding every piece of your work in a set order, saved to the shared class folder your teacher names, so it opens in a single try from there. Extra polish, such as renaming every file, running more rounds of testing or writing up the partner open-test in detail, comes only if time allows.

    3 - What Good Documentation Looks Like ~3 mins

    A judge or classmate who never saw you build this should still be able to follow it. Good documentation means:

    • Clear names for files, pages, sprites, variables and functions so a reader can tell what each one is for
    • Comments or short notes on the tricky parts: what a section does and why you chose that approach
    • A short written overview: what the work is, who it is for, and how to run or open it
    • Honest AI notes: where a tool helped (drafting, explaining, suggesting), and what you changed or checked yourself
    • Evidence of process: plan, tests, feedback you acted on, and any ethical or legal point you considered

    4 - Good Enough Looks Like This ~2 mins

    Good enough looks like this:

    • Someone else can open the main work in one try
    • AI help is named, with what you changed or checked
    • At least one test is noted, plus what you fixed
    • One ethical or legal point is written (or a clear reason none major applies)

    5 - Two Worked Examples ~1 mins

    Example overview: "This is a MakeCode Arcade sorting game for first years learning recycling. Open recycling_game in MakeCode Arcade and select Run. Arrow keys move the sorter; score rises when plastic hits the right bin."

    Example AI note: "ChatGPT suggested a fix for my sprite overlap bug. I tested the change, kept only the overlap block, and rewrote the comment in my own words."

    Your teacher will also show a short checklist of what makes documentation good: the work can be understood, decisions are explained, testing is shown, AI use is noted, and ethical issues are considered. Packaging means putting everything into one clear folder or portfolio that a marker can open without guessing. Unless your teacher changes it, the layout is four parts in this order: 01_Overview, 02_Project, 03_Process and 04_AI_and_ethics, with the main thing you made sitting at the top of 02_Project so it opens in one click.

    123learn · Online learning platform

    Unlock the full learning experience

    You're previewing this lesson. Get full access to this lesson and hundreds more — each one ready to teach, with interactive activities, printable resources and pupil progress tracking built in.

    Hundreds of curriculum-aligned lessons
    Interactive activities in every lesson
    Printable resources & progress tracking
    Copyright Notice
    This lesson is copyright of 123Learn.ie 2017 - 2025. Unauthorised use, copying or distribution is not allowed.
    🍪 Our website uses cookies to make your browsing experience better. By using our website you agree to our use of cookies. Learn more