All entries for Technical documentation
Recommend+To? A Clear Recommendation
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
Technical documentation and search engine optimization.
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
API documentation – What software engineers can teach us
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