How to Write Really Good Docs

Overview

Discover the secrets to creating exceptional documentation in this comprehensive video tutorial. Learn from Dan Jutan, an expert who has contributed to improving documentation for projects like Solid and Astro. Explore key concepts such as user-focused documentation, content organization strategies, and practical tips for writing effective docs. Gain insights on topics including the challenges of user-focused documentation, the concept of "Ryandocs," and how to approach documentation for projects of various sizes. Dive into discussions on README files versus dedicated documentation sites, utilizing tools like HackMD.io, and best practices for structuring content. Whether you're a solo developer or part of a larger team, acquire valuable skills to enhance your project's documentation and increase its chances of success.

Syllabus

- Welcome
- Who is Dan Jutan?
- What makes good docs?
- User focused docs are hard because you cannot control the funnel
- What are Ryandocs?
- Dan’s announcement about Solid
- If I want to document my project, what should I do?
- Split content types into four quadrants
- What about documenting projects for teams of one or two?
- Readme vs Docs sites
- Using HackMD.io
- Using bullet lists to start writing
- Where do your types go?
- Any other resources for learning about doc writing?