Knowledge base articles

In software development, the keyword agile is at least as popular as DITA in technical writing. This is no surprise. Both agile and DITA focus on modularization and the requirements of the users. In this article, we discuss how agile documentation works in practice, recommend tools that support the agile processes and point out the challenges for technical writers. more...

Usually, we create technical documentation in the form of a manual – for specific target groups and product versions. With the help of content management systems, we add metadata to our text modules and generate exactly the manual we want. Now, with the Internet of Things and a much stronger focus on modular information, our classic manual does not seem to have a future anymore. more...

This article gives an introduction to knowledge management. The target readers are technical writers as I prepared this summary for a technical writing conference. However, others may hopefully also find it useful.more...

Wikis are old, and old are the problems that wiki authors and readers struggle with. Collaborative authoring in wikis might tap new synergies but often the outcome is as chaotic as a humming beehive.  So how can you structure your content? How can you make it accessible? How can you organize reviews and input supply? more...

Anna M. is a software engineer. She has just started working for a company that develops custom add-ons for an out-of-the-box financial software solution. For developing the add-ons, Anna is supposed to use the API of the software. Little does Anna know about the API's structure, its interfaces, and its functionality. more...