Document formats – There is choice
Did you know that everyone can contribute to good and even better SUSE documentation?
For example, in the real spirit of open source, we invite all technical experts of the SUSE ecosystem to share their expertise and knowledge via a SUSE Best Practices document. The SUSE Best Practices are a series of documents that provide reliable technical information not covered with the SUSE product documentation and based on real-life scenarios. While the SUSE product documentation mainly guides through the installation and usage of a product, the SUSE Best Practices provide installation and implementation experiences. And while the SUSE product documentation is delivered in parallel with a new product or a next version, the SUSE Best Practices usually adhere to products already introduced to and established in the market.
But the SUSE Best Practices are not the only option to get involved. You can also contribute to or help enhance the existing product documentation. To do so, you can or submit a bug via Bugzilla, or edit the documentation sources in GitHub yourself. Usually, when I mention these options during conversations, I am asked “how” we write documentation at SUSE, means what tools we use to actually write our content.
Well, there are plenty of tools that can be used to create documentation texts, depending on the authors’ preference. For SUSE documentation, we currently work with two different document formats which are explained here a bit more in detail.