Documentation is Teaching, and Teaching is Everything
Tips and tricks for making documentation easier, and helping users find it
Presented by:
cschroder
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 cloud technologies.
Writing documentation is easy, but why bother because nobody ever reads it anyway.
Right? Doesn't everyone feel this way at least once in awhile? Writing 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
- Procedural, with examples of both correct and incorrect results
- Simple and direct
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. Let me 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.
- Date:
- 2018 April 28 - 07:15
- Duration:
- 1 h
- Room:
- CC-201 TUT1
- Conference:
- LinuxFest Northwest 2018
- Language:
- Track:
- Education
- Difficulty:
- Easy
- The Complete History of Linux (abridged)
- Start Time:
- 2018 April 28 07:15
- Room:
- HC-108
- Documentation is Teaching, and Teaching is Everything
- Start Time:
- 2018 April 28 07:15
- Room:
- CC-201 TUT1
- Building Your own Cloud on a Pi
- Start Time:
- 2018 April 28 07:15
- Room:
- CC-202 TUT2
- Proxmox Hypervisor - Open Source LXC and KVM management
- Start Time:
- 2018 April 28 07:15
- Room:
- CC-235
- Moving Forward with Firewalld
- Start Time:
- 2018 April 28 07:15
- Room:
- CC-200
- digiKam Ninja Tricks
- Start Time:
- 2018 April 28 07:15
- Room:
- CC-208
- Why C? Refuting C++ Pretentiousness
- Start Time:
- 2018 April 28 07:15
- Room:
- CC-236
- IndieWeb 101: owning your content and identity
- Start Time:
- 2018 April 28 07:15
- Room:
- CC-115
- Do Licenses Drive Communities or Do Communities Drive Licenses?
- Start Time:
- 2018 April 28 07:15
- Room:
- G-103
- Linux Jargon
- Start Time:
- 2018 April 28 07:15
- Room:
- CC-114
- Make a date with Postgres
- Start Time:
- 2018 April 28 07:15
- Room:
- HC-103 Postgres
- Linux Professional Institute: LPIC-1 Cram Session
- Start Time:
- 2018 April 28 07:30
- Room:
- HC-112 LPI