Writing Software Documentation

In this episode I talk with Alessandro Stazi and Professor Sissi Closs about creating software documentation. With software documentation, we mean online help, API documentation and all other user instructions for software applications. Listen to this episode if you want to gain more insight on how to write good documentation, how to use standards for software documentation and what the future of software documentation will look like.

In this episode I talk with Scott DeLoach and Mike Unwalla about Using Style Guides in Technical Communication. A style guide is a set of standards for writing and designing content. It helps you to write documentation in a clearer way and to keep a consistent tone of voice and style. Listen to this episode if you want to gain more insight on how to apply existing style guides or create your own to improve the quality of your ‘information for use’. .

In this podcast episode, I am interviewing Paul Hoogerkamp about How to CE Machinery. As we specialise in creating user manuals for machinery, many of our clients are involved in the certification process. I think it is useful for them, and for technical writers, to have more insight in this process. Listen to the interview below and make sure to subscribe to the INSTRKTIV’S INSANE INSTRUCTIONS SHOW on your favourite podcasting platform. You can find the free transcript of this episode on this page as well. If you have a topic or question you’d like me to cover, send me an email here.  

In this podcast episode, I am interviewing Paul Hoogerkamp about How to CE Mark a Product. We take the certification of PPE as an example, due to the high demand on face masks currently. As we specialise in creating user manuals for products, many of our clients are involved in the certification process. I think it is useful for them, and for technical writers, to have more insight in this process.

In this podcast episode, I am interviewing Martin de Graaf about How to CE Mark a Medical Device. As one of our specialisms is creating Instructions for Use (or IFU) for medical devices, many of our clients are involved in the certification process of medical devices. I think it is useful for them, and for technical writers creating the IFU, to have more insight in the certification process of medical Devices.

PODCAST: CE Marking and Requirements on Information for Use. Information for use plays an important role in the process of product compliance. Making sure that your product and its documentation complies ensures that you are allowed to trade your product internationally, your liability decreases and legal pitfalls are avoided. In this podcast, I am interviewing Jens-Uwe Heuer James, a renowned lawyer specialising in product liability and product safety. Listen to the interview below and make sure to subscribe to the INSTRKTIV’S INSANE INSTRUCTIONS SHOW on your favourite podcasting platform. You can find the free transcript of this episode on my website as well. If you have a topic or question you’d like me to cover, send me an email here.

Creating user manuals that comply with the long list of requirements of the Machinery Directive is a challenging task. Finally, a standard has been developed that specifically focuses on creating instruction handbooks for machinery. In this podcast, I am interviewing Martin Reader, who has has been part of the committee that developed the standard. Listen to the interview below and make sure to subscribe to the INSTRKTIV’S INSANE INSTRUCTIONS SHOW on your favourite podcasting platform. You can find the free transcript of this episode on my website as well. If you have a topic or question you’d like me to cover, send me an email here

User support often does not effectively satisfy the propensities of the user. That’s what John Carroll and his colleagues at IBM observed around 1982 and how the minimalist approach to technical documentation began. Minimalism in technical communication is a use and user-centered approach to create better user support. . In this podcast, I am interviewing Dr. Hans van der Meij, who has been researching the principles of minimalism for almost 30 years. Hans explains the four principles and how they help to reduce training time while increasing learning. Listen to the interview below and make sure to subscribe to the INSTRKTIV’S INSANE INSTRUCTIONS SHOW on your favourite podcasting platform. You can find the free transcript of this episode on my website as well. If you have a topic or question you’d like me to cover, send me an email here.

Creating user guides that users love to use can be a challenging task. Not only do you need to master technical writing, but you also need to be familiar with designing, visualising, usability principles, legal stuff, and good old-fashioned psychology. The IEC/IEEE 82079-1-2019 Standard on Preparation of Information for Use provides guidelines that help you create better instructions. If you want to create happier users and make sure that you fulfill market, legal, and regulatory obligations, applying this standard is an absolute must. In this podcast, I am interviewing Sven Ring, who has been part of the committee that developed the 82079 standard. Sven talks about how an international and interesting group of people has developed a standard that helps anyone who wants to create user instructions. Sven Ring is a technical documentation and information expert. He currently works for a Chinese wind turbine manufacturer. Sven has 34 years of experience in technical communication. Listen to the interview below and make sure to subscribe to the INSTRKTIV’S INSANE INSTRUCTIONS SHOW on your favourite podcasting platform. You can find the free transcript of this episode on my website as well. If you have a topic or question you’d like me to cover, send me an email here.