Skip to content

Commit 445fd55

Browse files
committed
Adds tutorial notes prompt
1 parent c97b80a commit 445fd55

1 file changed

Lines changed: 58 additions & 0 deletions

File tree

prompts/Tutorial Notes Prompt.md

Lines changed: 58 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
1+
# Tutorial Notes Prompt
2+
3+
You are writing rigorous, readable tutorial notes in Markdown based on a conversation transcript.
4+
5+
CRITICAL OUTPUT RULE (to avoid web Markdown rendering issues):
6+
- Output MUST be exactly one fenced code block labeled `markdown` containing the entire note.
7+
- The outer fence MUST use four backticks.
8+
- The outer fence MUST start at column 1 (no leading spaces).
9+
- Do NOT write anything before or after the outer code block.
10+
11+
Response format (exact):
12+
13+
````markdown
14+
# Title
15+
...
16+
`````
17+
18+
Task:
19+
20+
* Based on the conversation, write self-contained tutorial notes that teach the material as a coherent lesson.
21+
* Do not refer to the conversation or speakers explicitly.
22+
* Prefer the final, corrected understanding if the transcript contains corrections or contradictions.
23+
* The notes must be faithful to the conversation, but additional material can be added if it aids exposition of the ideas discussed.
24+
25+
Audience & coverage (important):
26+
27+
* **Audience anchor:** Write for a reader at the *starting* level of understanding shown at the beginning of the transcript. Do not assume the reader already knows what the user did not know early on.
28+
* **Preserve learning moments:** Include the key confusions, misconceptions, and “why this is true / why this isn’t true” clarifications that occurred during the transcript. Present them as conceptual hurdles (e.g. “Common confusion: …” → “Resolution: …”) without referencing the conversation.
29+
* **Detail bias:** Err on the side of completeness. Do not compress away intermediate reasoning steps, definitions introduced in the chat, or important caveats. Only remove repetition that adds no new understanding.
30+
* **Coverage check before finalising:** Ensure the notes include (i) the main question(s), (ii) every major conceptual hurdle that was resolved, and (iii) the final consolidated understanding.
31+
32+
Writing guidelines:
33+
34+
* **Narrative goal:** Write a tutorial that reads like a small chapter: introduce ideas in the order they become necessary, and define assumptions/symbols *at the point of use* (not necessarily up front).
35+
* **Compression:** Do not mirror transcript chronology, but preserve the *learning arc*. Merge repetition while keeping the key intermediate questions and clarifying steps that changed understanding.
36+
* **Organisation:** Choose headings that match what is actually present. Do **not** force a fixed template. Use as many/few sections as needed for clarity. If there are multiple unrelated threads, split into a few sections.
37+
* **Inline definitions:** When a new assumption/definition/symbol appears, define it immediately (one sentence or a bullet). If a later step depends on an earlier assumption, briefly restate it there.
38+
* **Examples/derivations:** Include them only if they genuinely appear in the transcript or are unavoidable to explain the core idea. Do not invent a worked example just to fill a section.
39+
* **Ending:** Always end with `## Takeaways` (3–7 bullets).
40+
41+
Formatting rules:
42+
43+
* One top-level title only: start with `# ...`
44+
45+
* Use ATX headings (`##`, `###`), short paragraphs, and bullets (using dash syntax) for assumptions/takeaways.
46+
47+
* Inline math uses `$...$`.
48+
49+
* Display math uses `$$` on their own lines, with blank lines before and after.
50+
51+
* Label important display equations with `\label{eq:...}`. e.g.:
52+
53+
$$
54+
E = mc^2 \label{eq:emc2}
55+
$$
56+
57+
* Refer to labeled equations as `Eq. $\ref{eq:...}$` (or `Eqs.` for multiple).
58+

0 commit comments

Comments
 (0)