Skip to content

Commit ff6c2ba

Browse files
committed
update docs
1 parent de71049 commit ff6c2ba

2 files changed

Lines changed: 25 additions & 7 deletions

File tree

docs/dev.md

Lines changed: 13 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,13 +3,24 @@ This chatbot aims to concisely respond to all relevant tasks the student request
33

44
Some technical details:
55
<pre style="white-space: pre-wrap;">
6-
<code>LLM model: Gemini-2.5-flash (Google)
7-
response time (on average): 10 seconds
6+
<code>LLM model: Gemini-2.5-flash-lite (Google)
7+
response time (on average): ~10 seconds
88

99
Helping approach: provides short, direct answers without extra detail
1010
</code>
1111
</pre>
1212

13+
## Behavioural Prompt
14+
15+
**Role:** A tutor that gives short, direct answers.
16+
17+
**Key behaviours from the role prompt**
18+
19+
- **Direct and minimal:** answers the question and stops — no extra details, explanations, or examples unless the student asks.
20+
- **Aware of struggle:** if the student seems stuck or frustrated, references their progress so far and how long they have spent on the question relative to the teacher's guidance time.
21+
- **Stays on topic:** redirects unrelated questions back to the current material with a short refusal.
22+
- **No filler:** does not end messages with concluding statements or summaries.
23+
1324
## Testing the Chat Function
1425

1526
To test your function, you can run the unit tests, call the code directly through a python script, or build the respective chat function docker container locally and call it through an API request. Below you can find details on those processes.

docs/user.md

Lines changed: 12 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,19 @@
11
# Concise Chatbot
22

3-
This chatbot aims to concisely respond to all relevant tasks the student requests based on the current Question they are working on. The Chatbot is aware of the Question details, answer, worked solution and guidance from the lecturer.
3+
Short, direct answers and nothing else. No preamble, no examples, no details — unless you ask for them. Best when you just need one missing fact to get unstuck.
4+
5+
**Example chat**
6+
7+
> **You:** How can I start solving this question?
8+
>
9+
> **Concise:** Consider which governing equation applies to this problem.
10+
11+
**Tip:** if a hint is too short, ask it to explain *why* — it'll expand.
12+
413

514
Some technical details:
615
<pre style="white-space: pre-wrap;">
7-
<code>LLM model: Gemini-2.0-flash (Google)
8-
response time (on average): 10 seconds
9-
10-
Helping approach: provides short, direct answers without extra detail
16+
<code>LLM model: Gemini-2.5-flash-lite (Google)
17+
response time (on average): ~10 seconds
1118
</code>
1219
</pre>

0 commit comments

Comments
 (0)