Brussels / 4 & 5 February 2017

schedule

Writing Open Source Documentation for Open Source Projects

How SUSE is documented and what we can learn from it


To publish it's documentation, SUSE has developed not only a comprehensive Open Source toolchain to create and publish documentation but also an open workflow that allows community and partners to provide feedback and contribute. These tools and processes can easily be adopted by other projects to write high quality software documentation.

SUSE has been around as Linux vendor for a long time and from it's early days onwards, delivered not only software but also the documentation to use it. In fact, SUSE is not only writing the documentation for it's own distributions but for upstream projects like OpenStack as well. Over time, the SUSE documentation team has developed not only a comprehensive, completely Free and Open Source toolchain to create, edit, manage, and publish documentation but also an open workflow that allows community and partners to provide feedback and contribute. These tools and processes can easily be adopted by other projects to write high quality software documentation, everything from a man page to a reference guide.

In this talk, Christoph will introduce the complete SUSE/openSUSE documentation workflow and tool chain. It will cover both the technical details like formats, tools, or branching model and the organizational aspects such as the feature planning and tracking, distribution of work and feedback process.

Speakers

Photo of Christoph Wickert Christoph Wickert

Attachments

Links