Can we add UML Diagrams to the Documentation?

CSA Resources, Tools, Differentiation
1

Hello - Really love the built-in Documentation. One suggestion is to add a screenshot of a Class UML Diagram at the top, inside the Documentation (see screenshots).

Unless I’m missing something, the UML is only available inside the Study Guide, but I think it would be convenient to also place it in Documentation.

Screen Shot 2022-09-15 at 08.43.05
Screen Shot 2022-09-15 at 08.43.05724×463 42.9 KB

Screen Shot 2022-09-15 at 13.39.54
Screen Shot 2022-09-15 at 13.39.54397×544 33.9 KB

4 Likes
2

Gaylon,

Thanks for thoughtful suggestion! This is definitely the type of feedback that we seek when iterating on curriculum and feature updates. I agree that providing the UML could help to bridge the gap between the Activity Guides for the units and the Documentation page available on the course.

I could also see how having the UML at the top that links to specific points in the documentation page could also make navigating the page easier (as it is quite long!)

Thanks so much and keep those thoughts coming!
Erik

3

Great suggestion, Gaylon!

I have found myself projecting the UML diagram as students work in unit 1, and had thought about writing it up on a chart paper to have up in the room. We are almost done with Unit 1, so I will probably do this in unit 2 as we get to the Dessert class, to serve as a sort of anchor chart.

Does anyone else use the UML diagrams in their rooms, or other anchor charts/ reference posters to help students as they code?

-Lindsay

2 Likes
4

I like the idea of having the UML with links. Just trying to reduce the number of clicks and speed up access to what they need.

Baby steps. :slight_smile:

3 Likes
5

This would be a great idea, either just a screenshot of the UML or a more useful linking one. Instead of trying to dig through the documentation, and maybe missing because they scroll too fast, having a quick list of available methods would be a benefit. Plus it would be more like the official java documentation with the Summary sections at the top: String (Java Platform SE 8 )

As it is, I put the UML on a separate “Reference” slides to share with my students along with direct links to documentation.

6

Thanks for the feedback on this thread @TClark !
I agree that is would be nice to have the documentation include UML diagrams- I actually plan on writing one with my class for the Painter class as we start the project this week, to help them remember what methods are available.

Code.org courses are always being updated by the curriculum teams, they choose the updates to provide in part based off of teacher feedback. If you email support@code.org with this request it will help to make UML diagrams a priority on the next course update.

Best,
Lindsay

1 Like