Getting Started/๐Ÿ“ Style Guide (Internal)

๐Ÿ“ Writing Style Guide

โš ๏ธ Note: This is an Internal Reference

This style guide is for content creators working on this course. It will be removed before production release. It ensures consistency across all pages and maintains our pedagogical approach.

Core Writing Philosophy

Write Like a Textbook, Not a Slide Deck

Our goal is to create narrative, flowing prose that reads like a conversation with an expert clinician. We're not creating bullet-point summaries โ€“ we're teaching complex concepts through clear explanation and reasoning.

๐ŸŽฏ Key Principle

Default to paragraphs. Use bullets only when listing discrete items that truly don't need explanation. If you find yourself writing 3+ sentence bullets, convert to prose.

The Problem With Bullet Points

Bullet points are useful for lists, but they create a fragmented reading experience when overused. Consider this example:

โŒ Poor Style (Bullet-Heavy)

S3 Gallop:

  • Occurs in early diastole
  • Low-pitched sound
  • Best heard with bell
  • Heard at apex in left lateral decubitus
  • Indicates volume overload
  • Normal in young patients
  • Pathologic over age 40

โœ… Better Style (Narrative)

S3 Gallop:

The third heart sound occurs in early diastole, shortly after S2, when blood rushes into the ventricle and suddenly decelerates. This creates a low-frequency vibration that you'll hear as a dull thud โ€“ think of the rhythm "Ken-TUC-ky" (S1-S2-S3).

Because it's so low-pitched, you must use the bell with very light pressure. Position the patient in left lateral decubitus and listen at the apex. Often, you'll feel it more than hear it โ€“ try placing your hand on the chest wall.

Here's the clinical twist: S3 can be completely normal in children, young adults (up to age 40), pregnant women, and well-trained athletes. In these populations, it simply reflects vigorous filling into healthy, compliant ventricles. But in adults over 40, S3 is always pathologic, signaling volume overload from conditions like heart failure or severe mitral regurgitation.

Notice how the narrative version:

  • Explains why, not just what
  • Uses natural transitions between concepts
  • Incorporates clinical reasoning organically
  • Maintains reader engagement through conversational tone
  • Builds a mental model instead of isolated facts

When to Use Bullets

Bullets are appropriate for:

โœ… Acceptable Uses:

  • True lists โ€“ Discrete items without explanation (e.g., the four heart valves)
  • Differential diagnoses โ€“ Quick reference lists
  • Steps in a procedure โ€“ Sequential actions
  • Quick reference summaries โ€“ After detailed explanation has been provided

โŒ Avoid Bullets For:

  • Explaining mechanisms or pathophysiology
  • Clinical reasoning or decision-making processes
  • Anything requiring more than 1-2 sentences per point
  • Sequential concepts that build on each other

Active Learning Techniques

Use Questions to Engage Critical Thinking

Questions force readers to actively process information rather than passively consume it. Use them strategically throughout your writing.

Types of Questions to Use:

1. Anticipatory Questions โ€“ Set up what you're about to explain:

"Why does aortic stenosis cause a crescendo-decrescendo murmur instead of a constant sound?"

2. Socratic Questions โ€“ Guide reasoning step-by-step:

"Think about it: if the left ventricle is stiff and non-compliant, what happens when the atrium tries to push blood in during late diastole? That's right โ€“ you get an S4."

3. Clinical Reasoning Questions โ€“ Promote active recall:

"A patient's murmur gets louder with squatting. Does this suggest HCM or mitral regurgitation? Before you read on, reason it through using what you know about preload and afterload."

4. Self-Check Questions โ€“ End sections with application:

"Pause here and ask yourself: Could I explain to a colleague why standing makes HCM louder? If not, re-read the hemodynamics section."

The "Stop and Think" Technique

Occasionally pause the narrative and explicitly ask the reader to engage:

Example:

"Before we move on, stop for a moment. You now know that inspiration increases right heart filling. Based on this, predict what will happen to a tricuspid regurgitation murmur during inspiration. Think through the mechanism, then continue reading."

This forces active processing and prevents passive skimming.

Narrative Structure Guidelines

Start With the "Hook"

Open each section by establishing why this matters or what puzzle we're solving. This primes the reader's brain to care about what follows.

Example:

"Mitral valve prolapse is one of the most common valvular abnormalities you'll encounter โ€“ up to 2-3% of the population. Yet it's also one of the most misunderstood. Here's why it's so clinically fascinating: it's a dynamic lesion. The murmur actually changes timing depending on the patient's position and volume status. Let's explore why that matters."

Build Conceptual Scaffolding

Introduce foundational concepts before complex ones. Each paragraph should build logically on the previous.

Template:

  1. What is it? โ€“ Basic definition
  2. Why does it happen? โ€“ Mechanism
  3. What do you hear? โ€“ Clinical findings
  4. How do you prove it? โ€“ Diagnostic reasoning
  5. Why does it matter? โ€“ Clinical significance

Use Transitions Between Concepts

Avoid abrupt topic changes. Guide the reader from one idea to the next.

Good transitions:

  • "Now that you understand the mechanism, let's explore how this sounds clinically..."
  • "This brings us to an important question:"
  • "Here's where it gets interesting:"
  • "Notice the pattern emerging..."
  • "Building on what we just learned..."

Formatting & Visual Elements

Headers: Use Hierarchically

H2 โ€“ Major topic shifts (e.g., "Mechanism", "Clinical Presentation")
H3 โ€“ Subtopics (e.g., "Acute vs Chronic", "Auscultation Technique")
H4 โ€“ Minor points within subtopics

Rule: Don't use a header unless it introduces at least 2-3 paragraphs of content. If it's just 1 sentence, integrate it into prose.

Info Boxes: Strategic Use

Use colored boxes to highlight key concepts, but sparingly. Too many boxes create visual clutter.

Info Box (Blue) โ€“ Key concepts, synthesis points
Warning Box (Red/Orange) โ€“ Critical clinical pearls, red flags, "don't miss" items
Tip Box (Green) โ€“ Practical bedside advice, mnemonics, study tips

Frequency guideline: Maximum 2-3 boxes per page. If you're using more, some content should be in regular prose.

Tables: When Comparison Is Key

Tables are excellent for:

  • Comparing similar conditions side-by-side
  • Showing maneuver responses across multiple murmurs
  • Summarizing key differentiating features

But: Always provide context before and after the table. Don't just drop a table without explanation.

Tone & Voice

Be Conversational, Not Casual

Write as if you're explaining to an intelligent colleague over coffee. Use "you" and "we" to create connection.

โœ… Good: "You'll notice that the murmur gets softer when the patient squats. Why? Let's think through the hemodynamics."

โŒ Too Formal: "It is noted that the intensity of the murmur decreases upon assumption of the squatting position."

โŒ Too Casual: "So yeah, squatting makes it quieter, lol."

Confidence Without Arrogance

Be authoritative but humble. Acknowledge when things are complex or uncertain.

Good: "This is a tricky distinction that even experienced clinicians sometimes miss."
Bad: "Obviously, anyone can tell the difference between..."

Avoid Unnecessary Jargon

Use medical terms when appropriate, but explain them the first time. Don't use jargon to sound smart โ€“ use it because it's precise.

First use: "The murmur exhibits a crescendo-decrescendo pattern โ€“ it gets louder then softer, like a diamond shape on a phonocardiogram."

Subsequent uses: "This crescendo-decrescendo murmur..."

Clinical Examples & Vignettes

Make It Real

Abstract concepts stick better when tied to clinical scenarios. Include realistic patient presentations throughout.

๐Ÿ“‹ Example Vignette Format

Scenario: A 68-year-old man presents with progressive dyspnea on exertion. You hear a harsh, late-peaking systolic murmur at the right upper sternal border that radiates to the carotids. His carotid upstrokes are weak and delayed.

Question: What's your diagnosis, and what would you expect to hear if he performs a Valsalva maneuver?

Common Pitfalls to Avoid

โŒ Don't Do This:

  • Wall of bullets โ€“ Converting every sentence to a bullet point
  • Header overload โ€“ Using H3 or H4 for every single sentence
  • Passive voice โ€“ "It is heard..." โ†’ "You'll hear..."
  • Redundancy โ€“ Saying the same thing in a box and in prose
  • Orphan headers โ€“ Headers followed immediately by another header
  • Facts without context โ€“ Stating what without explaining why

Quick Reference Checklist

Before finalizing any page, ask yourself:

  • โ˜ Did I prioritize narrative prose over bullet points?
  • โ˜ Did I use questions to engage active learning?
  • โ˜ Did I explain the "why" not just the "what"?
  • โ˜ Are my transitions smooth between concepts?
  • โ˜ Did I include at least one clinical scenario or example?
  • โ˜ Is my tone conversational but professional?
  • โ˜ Did I use boxes sparingly (โ‰ค3 per page)?
  • โ˜ Are my headers hierarchically organized?
  • โ˜ Could a student reason through this, not just memorize it?

Examples: Before & After

Example 1: Aortic Regurgitation

โŒ BEFORE (Bullet-Heavy, No Narrative)

Aortic Regurgitation

  • Diastolic murmur
  • High-pitched, blowing
  • Decrescendo pattern
  • Best heard at left sternal border
  • Patient should lean forward
  • End-expiration
  • Causes: bicuspid valve, endocarditis, rheumatic disease, aortic dissection
  • Bounding pulses
  • Wide pulse pressure
  • Austin Flint murmur in severe cases

โœ… AFTER (Narrative, Active Learning)

Aortic Regurgitation

Picture this: the aortic valve doesn't close properly, so with each heartbeat, some blood leaks backward from the aorta into the left ventricle during diastole. This creates one of the most characteristic murmurs in cardiology.

What would you expect to hear? Think about the physics for a moment. Blood is flowing from a high-pressure chamber (aorta) into a lower-pressure chamber (LV) during early diastole. The pressure gradient is highest right after S2 and decreases as diastole progresses. This creates a decrescendo pattern โ€“ the murmur starts loud and fades away, like air slowly leaking from a balloon.

The sound itself is high-pitched and blowing, almost like a soft "whoosh." To hear it best, position the patient sitting up and leaning forward (this brings the aortic valve closer to the chest wall). Listen along the left sternal border at the 3rd-4th intercostal space, and have the patient exhale and hold their breath โ€“ this brings the heart even closer to your stethoscope.

Now here's where it gets clinically interesting. Severe AR doesn't just create a murmur โ€“ it causes dramatic peripheral signs. The blood that leaked back into the LV has to be ejected again, so stroke volume increases massively. This creates bounding pulses that you can see and feel. Check the pulse pressure: you'll find it's abnormally wide (often >60 mmHg). The systolic BP might be normal or even high, but the diastolic plummets because blood is regurgitating back into the LV instead of maintaining diastolic pressure in the arteries.

Ask yourself: what happens to the LV over time if this continues chronically? That's right โ€“ it dilates to accommodate the extra volume. And here's a fascinating clinical pearl: in severe chronic AR, you might hear a second murmur โ€“ the Austin Flint murmur. This is a low-pitched diastolic rumble at the apex that sounds just like mitral stenosis but isn't. The regurgitant jet actually flutters the anterior mitral leaflet, creating functional stenosis. Pretty remarkable, isn't it?

Summary

Our writing style isn't about being flowery or verbose โ€“ it's about creating understanding through narrative. We're building mental models, not memorization lists.

Remember:

  • Prose > Bullets
  • Why > What
  • Questions > Statements
  • Reasoning > Memorization

When in doubt, ask yourself: "Am I teaching someone to think like a clinician, or just giving them facts to memorize?" Aim for the former.

Interactive Elements: Making Learning Active

Static content teaches. Interactive content transforms. Every page should include opportunities for active recall, self-testing, and immediate feedback. This section outlines our complete interactive element system.

Core Pedagogical Principles

Our interactive elements are grounded in learning science:

  • Retrieval Practice โ€“ Testing strengthens memory more than re-reading
  • Immediate Feedback โ€“ Corrects misconceptions before they consolidate
  • Spaced Repetition โ€“ Reviewing content at increasing intervals improves retention
  • Varied Formats โ€“ Different question types engage different cognitive pathways
  • Progressive Disclosure โ€“ Revealing complexity gradually prevents overload

Question Types (Pedagogical Function)

Different questions serve different learning goals. Use the right type for your purpose:

1. Anticipatory Questions

Purpose: Prime the learner's brain before presenting new information

Format: Blue box with thought bubble emoji ๐Ÿ’ญ

Example: "Before we explain the mechanism, ask yourself: Why would a stiff ventricle create a sound during atrial contraction?"

Implementation: Click-to-reveal answer (see UI Patterns below)

2. Socratic Questions

Purpose: Guide step-by-step reasoning through a complex concept

Format: Green box with brain emoji ๐Ÿง 

Example: "Let's reason through this. If preload increases, what happens to ventricular volume? And if volume increases, what happens to flow across a stenotic valve?"

Implementation: Multi-step walkthrough (progressive reveal)

3. Clinical Reasoning Questions

Purpose: Apply knowledge to realistic scenarios

Format: Orange box with stethoscope emoji ๐Ÿฉบ

Example: "A 65-year-old with a systolic murmur performs Valsalva and the murmur gets louder. What's your top differential?"

Implementation: MCQ with detailed explanations

4. Self-Check Questions

Purpose: End-of-section comprehension check

Format: Purple box with checkmark emoji โœ“

Example: "Can you now explain why squatting decreases the HCM murmur without looking back?"

Implementation: Click-to-reveal or text entry

5. Integration Questions

Purpose: Synthesize information across multiple sections

Format: Red box with puzzle emoji ๐Ÿงฉ

Example: "Compare the response to squatting in HCM, MVP, and MR. What's the underlying hemodynamic principle?"

Implementation: Complex MCQ or matching exercise

UI/UX Patterns: Implementation Guide

These are the mechanics of how users interact with questions. Each pattern includes complete implementation examples with refined, academic styling.

Design Philosophy

Our interactive elements use subtle, sophisticated styling that matches the course's academic aesthetic. We avoid bright colors, excessive borders, and childish design patterns in favor of typography-driven hierarchy, generous whitespace, and elegant transitions.

Pattern 1: Click-to-Reveal

Best for: Low-stakes reflection, anticipatory questions, quick self-checks

Design Principles:

  • Subtle cream background (#FBF8F3) - no bright colors
  • Thin border in course brown (#CD853F) - refined, not blocky
  • Typography-first: Use font weight/size for hierarchy, not color
  • Generous padding and whitespace
  • Smooth transitions (0.3s ease)

Full Working Example (Interactive):

Think: What would happen to preload if a patient stands up quickly?