Notes On Work - by Caleb Porzio

Writing docs in the age of AI

12 snips
Nov 9, 2025
Dive into the vital role of documentation in tech projects as Caleb shares his struggles with poor docs that shattered his trust in tools. He highlights Laravel's exemplary documentation and how it boosts developer confidence. Personal barriers to writing docs are explored, alongside the benefits of deadlines for improvement. There's a fascinating discussion on AI's role, from critiquing structure to enhancing clarity, along with the crucial importance of code examples. Ultimately, AI transforms and accelerates the documentation process.
Ask episode
AI Snips
Chapters
Transcript
ANECDOTE

Docs Can Destroy Trust Quickly

  • Caleb struggled to use a simple tool because its documentation was broken and sparse.
  • Poor docs made him distrust the project despite its strengths.
ANECDOTE

Laravel Sets A Documentation Standard

  • Caleb contrasts Laravel's excellent docs with other poor docs he encountered.
  • He credits Taylor Otwell for prioritizing documentation quality.
INSIGHT

Docs Require Voice Discipline

  • Writing docs requires clarity and sacrifices personal voice and humor.
  • Documentation demands 'clarity at all costs' versus the engaging voice used in blogs.
Get the Snipd Podcast app to discover more snips from this episode
Get the app