From c92bce22a096db9275756628613317998b083359 Mon Sep 17 00:00:00 2001 From: Christian Kolset Date: Wed, 30 Apr 2025 09:12:41 -0600 Subject: Updated book pdf --- tutorials/module_2/documentation.md | 2 ++ 1 file changed, 2 insertions(+) (limited to 'tutorials') diff --git a/tutorials/module_2/documentation.md b/tutorials/module_2/documentation.md index 817914a..984c404 100644 --- a/tutorials/module_2/documentation.md +++ b/tutorials/module_2/documentation.md @@ -9,7 +9,9 @@ When documenting a project, it's essential to include detailed notes that captur ## Explain Your Decisions In programming, there are often several valid approaches to solving a problem. When documenting your code, it's important to clarify why you chose a particular method—especially if it deviates from common practices. Anticipating potential questions and addressing them directly in your documentation helps others follow your reasoning and builds trust in your solution. + ![Rubber duck debugging technique](figures/rubberDuck.png) + A useful strategy for articulating these decisions is the "rubber duck" technique—explaining your code as if you're teaching it to someone else. Whether spoken aloud or written down, this practice helps you clarify your logic and communicate the reasoning behind your choices, providing valuable context for future collaborators or reviewers.​ ## Include a README -- cgit v1.2.3