Skip to content

CLAUDE.md

Latest commit

 

History

History
110 lines (84 loc) · 2.56 KB

CLAUDE.md

File metadata and controls

110 lines (84 loc) · 2.56 KB

Technical Content Creation Guide

Transform technical books into engaging, learnable content

🎯 Core Method

Process: Research authoritative sources → Add superior teaching → Create organized content

Key Principle: Use established technical structure + enhance with superior learning methods

📋 Content Structure

Numbered TOC (Required)

## Table of Contents
1. [Introduction](#1-introduction)
2. [Main Topic](#2-main-topic)
   - 2.1. [Subtopic](#21-subtopic)
3. [Summary](#3-summary)

Header Numbering (Required)

  • Main: ## 1. Introduction
  • Sub: ### 2.1. Subtopic
  • Sub-sub: #### 2.1.1. Detail

Navigation (Required)

---
**Previous:** [Link] | **Next:** [Link]

Rules:

  • ✅ Every header appears in TOC
  • ✅ Hierarchical numbering (1, 1.1, 1.2, 2, 2.1)
  • ✅ Working anchor links
  • ❌ No orphaned entries

🎨 Teaching Techniques

Analogies First

**Like in everyday life:** [Familiar comparison]
**In technical terms:** [Actual concept]
**Why it matters:** [Real-world benefit]

Progressive Examples

Simple concept → Intermediate application → Advanced implementation

Insight Boxes

> **💡 Insight**
>
> [Key knowledge that connects concepts to broader patterns]

Visual Diagrams

Simple Flow          Complex Reality
───────────         ─────────────
Step 1         →    Detailed Process A
Step 2         →    Detailed Process B
Step 3         →    Detailed Process C

Complexity Breakdown

  • ❌ "Complex enterprise architecture with microservices, event sourcing, and CQRS patterns"
  • ✅ "1. Break problem → 2. Solve pieces → 3. Connect solutions → 4. Scale system"

Code Examples

  • Explain before showing - Context first, code second
  • Use realistic examples - Actual commands that work
  • Show expected output - What should happen
  • Test everything - All examples must work

✅ Quick Reference

Structure:

  • Numbered TOC with working links
  • Consistent header numbering
  • Navigation links

Teaching:

  • Start with analogies
  • Use progressive examples
  • Include insight boxes
  • Add visual diagrams
  • Break complex concepts into steps
  • Explain before showing code

Quality:

  • All examples work and are realistic
  • Clear progression from simple to advanced
  • Concepts connected to broader patterns
  • Code examples tested

Transform complex technical content into learnable knowledge