All entries for Technical documentation

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

If you could use just three technical writing tools in your company, which ones should you use? read more