Documentation: The Missing Pieces
Document all the things, they say! But are we documenting for ALL the PEOPLE? It seems that most documentation is written for the intermediate and above devs, the devs who have been around, and the devs who are already comfortable with programming.
But what about the true beginners, the career-transitioners, or those crossing domains? Most documentation is certainly not written for them!
In this talk, I'd like to explore the ways we can make our documentation better by considering more kinds of people. We'll discover common oversights and assumptions most documentation has built-in by default and learn how to fix them. We'll also strengthen our technical writing skills to ensure, to the best of our ability, that every anticipated reader of our documentation never feels lost or frustrated.
By the end of this talk, you'll leave and never write your documentation in the same way again...and that's a good thing!