What The Doc?!?! How to Write and Read Documentation That Allows You To Get Sh*t Done!
summary
Argues that documentation saves support time and onboarding effort by giving concrete fixes: provide a big red newbie button that shows the first three steps, include a list of tools with clickable links to set up environments, make docs searchable, assign someone to add documentation updates to the merge process, and flag easy issues for contributors. Require a short abstract, a vetted video or link list, a code of conduct with concrete examples, and a style guide so contributors and non‑technical reviewers can actually get stuff done.
AI-written summary · about
chapters (13)
- 0:00Intro
- 0:35Who am I
- 2:16My credentials
- 3:16Documentation
- 4:14Engagement
- 5:03Why Documentation
- 5:34This is not about you
- 6:20New to code
- 13:37Know why youre there
- 20:20Three areas of concern
- 25:57Use external documentation
- 27:43Code of Conduct
- 30:16Questions
related talks
39mSave a Dev, Write a Doc!
01h 24mWriting Documentation - Practices and Theory
29mMove Fast and Document Things: Writing internal docs at fast-moving organizations
28mStop writing docs; start helping!
28mImproving Your Documentation: A talk for developers who want to write stuff good
30mTechnical Documentation
45mDocs or it didn't happen!
14mdocs docs docs