How to Write Really Good Docs

This course introduces ways to plan and write user-focused documentation for software projects, including choosing between a README and a docs site and organizing different types of content. It also demonstrates using HackMD and bullet lists to get started.

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?