The Art of Documentation and Readme.md
summary
GitHub’s survey shows documentation being incomplete and confusing ranks way above everything else, so focus is on concrete fixes: provide runnable examples, checklisted getting-started steps, and one-click environments. Examples include an Katzcoda browser VM that removes install pain, Gitpod one-click IDE and Glitch demos for instant examples, Stripe-style copy-paste snippets, Spotify’s tokenized snippets, Grammarly and alexjs inclusivity checks plus GitHub Actions to auto-validate docs, Kubernetes enhancement proposals and documentation sprints to turn users into contributors.
AI-written summary · about
chapters (10)
- 0:00Start
- 5:27Reading Large Blocks Of Text is difficult
- 22:27Documentation Requirements Change
- 25:47user's emotions at this point
- 26:33Stack Overflow? Github Issues?
- 27:57The best documentation is the one you don't have to write
- 29:46Community and Contributor guidelines
- 31:24Code of Conduct
- 44:07WHAT IS THE ART OF DOCUMENTATION??
- 45:12Everyone has a story to tell.
related talks
35mThe Art of Documentation and Readme.md for Open Source Projects
51mWriting the Darn Docs
29mHumanizing Your Documentation
44mUseful and Beautiful Developer Docs and How to Create Them
49mExplain Yourself! Documentation for Better Code
25mHi, my name is README!
28mHumanizing Your Documentation
56mEffective Documentation: The Key to Open Source Growth