List of talks at PyCon SK 2018

All Machine Learning / AI Community / Diversity / Social Data Science DevOps Documentation Education Python General Security Soft Skills Hardware Web Development Other

Docs or it didn't happen
English flag Talk Documentation

Mikey Ariel (CZ)

If you ever skimmed through a README, tried to follow a quickstart tutorial, attempted to decipher an error message, or typed '--help' in your terminal, congratulations -- you have encountered documentation!

Long gone are the days of massive books with never-ending stories about your software. Today's users are smarter and less patient, which means that we no longer need to document *all the things*, as long as what we do document is clear, concise, helpful, and accessible. And that's where the real work starts.

Documentation requires some attitude adjustment, since prose doesn't neatly compile into binaries as code does. But Don't Panic(tm)! No matter what your role is in the community, you can apply a few key principles from the technical writing world to make your project more docs-friendly, and therefore more user- and contributor-friendly.

This high-level (and all-level) talk aims to introduce or re-acquaint you with topics such as content strategy, docs-as-code, optimized DevOps for docs, and contribution workflows. Open-source projects of all shapes, ages, sizes are welcome!

Documentation clinic/helpdesk
English flag Workshop Documentation

Mikey Ariel (CZ)

TBD