From 29f2b3d7d270f30e455366581a1fd65ba01def28 Mon Sep 17 00:00:00 2001 From: Mark Liffiton Date: Fri, 30 Aug 2024 10:37:05 -0500 Subject: [PATCH] Clarify instructor access to help interface. --- src/codehelp/docs/recommended_practices.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/src/codehelp/docs/recommended_practices.md b/src/codehelp/docs/recommended_practices.md index c7ec26d..d318006 100644 --- a/src/codehelp/docs/recommended_practices.md +++ b/src/codehelp/docs/recommended_practices.md @@ -10,7 +10,7 @@ Based on our experiences, we have collected a few recommendations for integratin ## Using Contexts Before you make CodeHelp available to your students, you should define one or more contexts. -We have a separate page about Using Contexts. +We have a separate page about [Using Contexts](contexts). ## Initial Introduction @@ -25,6 +25,7 @@ Providing good and bad examples or taking a moment to roleplay a few situations In particular, it is probably worth showing students which parts of the error messages in the language you're using are most important (e.g., the error type, detailed description, and quoted/highlighted line on which it occurred). Demonstrate CodeHelp with a few issues similar to those you expect your students to encounter. +(The [Get Help](/help/) link in the navigation bar brings you to the same interface students use.) Model how to provide sufficient information and communicate clearly. ## During Use @@ -34,5 +35,5 @@ In this way, you can gain insight into where they are struggling at each point i Additionally, you might identify students whose usage is not effective (e.g., repeatedly submitting ineffective queries or demonstrating overreliance), and reach out to them directly to provide guidance or a nudge. Instructors and TAs should sample CodeHelp's responses in each section of the course to spot and mitigate issues. -For example, if CodeHelp suggests a technique, function, or concept that does not fit the design of your course, you can add that to the avoid set in the the relevant context to produce more appropriate responses to similar queries in the future. +For example, if CodeHelp suggests a technique, function, or concept that does not fit the design of your course, you can add that to the avoid set in the the relevant [context](contexts) to produce more appropriate responses to similar queries in the future.