We're sorry but this page doesn't work properly without JavaScript enabled. Please enable it to continue.
Feedback

Writing Open Source Documentation for Open Source Projects

Formal Metadata

Title
Writing Open Source Documentation for Open Source Projects
Subtitle
How SUSE is documented and what we can learn from it
Title of Series
Number of Parts
611
Author
License
CC Attribution 2.0 Belgium:
You are free to use, adapt and copy, distribute and transmit the work or content in adapted or unchanged form for any legal purpose as long as the work is attributed to the author in the manner specified by the author or licensor.
Identifiers
Publisher
Release Date
Language
Production Year2017

Content Metadata

Subject Area
Genre
Abstract
To publish it's documentation, SUSE has developed not only a comprehensiveOpen Source toolchain to create and publish documentation but also an openworkflow that allows community and partners to provide feedback andcontribute. These tools and processes can easily be adopted by other projectsto write high quality software documentation. SUSE has been around as Linux vendor for a long time and from it's early daysonwards, delivered not only software but also the documentation to use it. Infact, SUSE is not only writing the documentation for it's own distributionsbut for upstream projects like OpenStack as well. Over time, the SUSEdocumentation team has developed not only a comprehensive, completely Free andOpen Source toolchain to create, edit, manage, and publish documentation butalso an open workflow that allows community and partners to provide feedbackand contribute. These tools and processes can easily be adopted by otherprojects to write high quality software documentation, everything from a manpage to a reference guide. In this talk, Christoph will introduce the complete SUSE/openSUSEdocumentation workflow and tool chain. It will cover both the technicaldetails like formats, tools, or branching model and the organizational aspectssuch as the feature planning and tracking, distribution of work and feedbackprocess.