All entries for Technical documentation

In technical documentation, we avoid recommendations. They rarely help the reader: The producer recommends ultra-light power cells. Why? What happens if I use others? read more

Lately, the newly developed tekom standard iiRDS has gained quite some attention. The next exciting step will be the release of version 1.0, which will be released soon. Requesting and delivering intelligent information as a standardized approach is a pioneering step in the Internet of Things – but let’s rewind a little. read more

Search engine optimization is a broad field. SEO agencies seem to be everywhere. Still, the technical documentation industry has not quite recognized the potential of search engine optimization. Why is that? read more

When asking software engineers about API documentation, you soon find out that there are two groups. The first group is convinced that good code does not require any explanation. Members of the second group frequently read documentation and even enjoy writing it. You also find out that software engineers have completely different opinions and approaches when it comes to the layout, presentation, and contents of a perfect API documentation. read more

What is the connection between a movie based on a comic and technical documentation? You might think there is none. But on Saturday I was delightfully surprised to find that Dr. Strange is an advocator of good documentation. Last Saturday was marvel-lous. read more