Writing open source documentation
2023-03-13 , Online Stage

Source code is only part of a successful open source project. Before people can use your program, they need to know how to run it. Before others can contribute to your project, they need to know how it works. That means good open source projects need to have great documentation.

In this workshop, we’ll learn about how to write good documentation. From how to arrange elements so your audience can read the documentation more easily, to how to proofread and edit your documentation. Your project documentation will shine after attending this workshop.

See also: Slides (2.1 MB)

Jim Hall is an open source software advocate and developer, best known for usability testing in GNOME and as the founder + project coordinator of FreeDOS. At work, Jim is CEO of Hallmentum, an IT executive consulting company that provides hands-on IT Leadership training, workshops, and coaching.