Inclusion Starts with Docs
summary
Great documentation increases inclusion by making projects usable and contributable; the claim here is that Elixir’s built-in tools make that low friction. The talk demonstrates ExDoc, using @moduledoc and @doc with executable doctests, typespecs and mix dialyzer checks, and shows mix docs publishing to hexdocs.pm. It shows interpolated install instructions that auto-update, adds --source-url links from docs to GitHub, and demo-builds a strip_js example library to prove the workflow actually works.
AI-written summary · about
chapters (14)
- 0:00Intro
- 0:41What is this?
- 1:51Some Questions
- 6:47Elixir Has Great Docs
- 9:31ExDoc Cheat Sheet
- 11:19Write Docs in Markdown
- 13:58Moduledocs
- 15:03TIP! Install Instructions
- 17:02Function Docs
- 21:37TIP! Doctests
- 23:06Data Types
- 25:41Dialyzer
- 26:45Source Code
- 29:51Read All About It!
related talks
35mWriting Documentation with Neurodivergent Open Source Contributors In Mind
15mAdopting Open Source Practices To Build More Inclusive Products and Services
44mTen Practical Approaches for Building Inclusive Open Source and InnerSource..
38mEngineer in Diversity & Inclusion - Tangible Steps for Teams
33mIncluding People
28mInclusive contribution Guidelines for Open Source Projects
39mCreating an Inclusive Community
05mInclusion: a positive experience