~/talk

How To Write About Software

Talkat SquiggleConf 2024 · 2024-10-03..10-04· [documentation, soft-skills]
name:Jess Lin
github:jssln
slides:none on file

Defines four clear post types and shows a concrete rewrite path using a Render Postgres case study: a 7,000‑word explain draft becomes a detective mystery by elevating a single slow query, moving background into an aside, cutting sentences, turning dense paragraphs into bullets, and tightening headings. Result: the series lands atop Postgres Weekly (16,000 subscribers), spawns a docs page of reusable debug queries, and teaches using PG stat activity and info boxes to make posts skimmable.

AI-written summary · about

  1. 0:00in this talk…
  2. 1:10introduction and motivation
  3. 3:00the three phases of the thought process
  4. 3:49about me
  5. 4:22about render
  6. 5:03phase 1: getting started
  7. 6:26goals and reasons to write
  8. 7:34phase 2: find the angle
  9. 7:494 types of tech blog posts
  10. 9:40applying the framework to Eric’s post
  11. 11:10phase 3: write + refine
  12. 11:32opening: before
  13. 12:18opening: after
  14. 13:15opening: another example
  15. 13:44openings: think about…
  16. 14:20headings: before
  17. 15:02headings: after
  18. 15:55body: making it skimmable
  19. 17:05body: bullets
  20. 17:52body: keep it moving
  21. 19:14body: “info box”
  22. 19:37title: before & after
  23. 21:24ending
  24. 22:28good v. great
  25. 23:45the impact of writing on a reader
  26. 25:06ingredients for greatness
  27. 26:42closing thoughts on your next great blog post
  28. 27:00audience questions and answers
~/search
type to search 6,249 conferences, 138,987 speakers and 185,172 talks
~/help
cmdctrl k
search every conference, speaker and series
/
focus the filter search
h
home
c
conferences
s
speakers
e
series
t
light / dark — the status bar button does the same
?
this help
esc
close this, then clear every filter — or just the search, while you are typing in it

Ignored while you are typing. Pages without a filter rail have no search to focus.