technical documentation Archives

August 6, 2019 12:55 pm

2,358 views

Help Us Improve: SUSE Documentation Survey

Why Documentation? Documentation is an essential part of any product. For many years now, you hear me repeating this over and over again. There is no product which is so simple to use and maintain, that it doesn’t require any description, introduction or examples. This is especially true for enterprise software which covers many […]

Tags: CaaSP, documentation, documents, product documentation, software documentation, solution-based documentation, survey, SUSE, SUSE CAP, SUSE Container as a Service Platform, SUSE Enterprise Storage, SUSE Linux Enterprise, SUSE Linux Enterprise Server, SUSE Manager, SUSE OpenStack Cloud, technical documentation, technical documents

Categories: Expert Views, Technical Solutions

By: chabowski

June 29, 2017 10:04 am

10,317 views

DocBook, AsciiDoc or Sphinx – Choices, Choices…! A Comparison of Document Formats

The following article has been contributed by Janina Setz, Trainee at SUSE. The original article has been published in German at DataCenter Insider. A big “Thank You” to chief editor Ulrike Ostler for the permission to publish the article in English at the SUSE blog. Anyone who has ever used an instruction […]

Tags: AsciiDoc, content, DocBook, document formats, documentation, editor, Emacs, Gedit, GitHub, guides, JEdit, manuals, markup language, Notepad+, oXygen, Sphinx, Sublime, technical documentation, technical writing, text modularization, versioning, Vi, Vim