All entries for Developer documentation

Digitalization is increasing the need for software documentation. This article provides an overview of the characteristics of software documentation and is geared toward beginners. We will try to give an answer to the question what good software documentation is and what technical authors need to know to create it. more...

For their localization software LiDAR-LOC, SICK needed an online help. parson developed a topic-based information architecture and created the online help. 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. 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...

Writing technical documentation for software engineers is more than authoring code comments. In order to use an application programming interface (API) or existing source code effectively, software engineers require different types of information. For this reason, technical writers who author API documentation need to analyze the requirements of their target group. more...