Thank you for an amazing SeaGL 2021!
Love SeaGL and want to help out? Get Involved

Documentation is Teaching, and Teaching is Everything

Everyone is a newbie at 99% of everything, so teaching is the most important and noble task of all. Creating and maintaining documentation is not easy, but it is necessary. Documentation is recording your accumulated experiences and creating your institutional memory. Documentation is building a library of knowledge, and adding to the total store of recorded human knowledge. Documentation is a primary tool for bringing new contributors up to speed efficiently. Good documentation = happy users. Teaching how to use your software reveals its flaws, and expands your own expertise.

Creating good documentation is not easy, but it is just as necessary as writing code. There are many options for creating good helpful documentation: wikis, blogs, videos, slideshows, wherever your imagination leads you. The important bit is doing something.

Some of the elements of good documentation are:

  • Concise and to the point
  • Task-oriented and procedural, with examples of both correct and incorrect results
  • Simple and direct: teach one thing at a time

After you have created your documentation people must be able to find it, and find what they want in it. And then someone has to maintain it.

This may all sound a little scary, like it’s complicated and a lot of work. I will show you how to minimize the pain and maximize pleasant results with proven tips and tricks learned from years of experience, such as SEO tricks to help users find your documentation, efficient tools and workflow, and how to encourage contributors.

Presenters

Carla Schroder

Carla Schroder

Lifelong nerd, Linux howto author since 1995, author of hundreds of tutorials and three books: Linux Cookbook, Linux Networking Cookbook, and the Book of Audacity. System administrator, network administrator, happy member of the amazing SUSE documentation team, currently working on bleeding-edge cloud technologies. Other careers include managing editor, farmer, auto mechanic, handymam, photographer, and others lost in the misty dawns of time.