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.

Instrktiv's Insane Instructions Show

Writing Software Documentation

What is a style guide for technical writers? A style guide is a set of standards for writing and designing content. A style guide for technical writing defines the style that should be used in technical communication, such as in user manuals, online help and procedural writing, within an organization. What are the benefits of using a style guide? A style guide helps you to write documentation in a clearer way and to keep a consistent tone of voice, and style. To improve the quality of the content that we create for our clients, we recently created our own style guide. This guide is inspired by some existing style guides. Using style guides in technical communication In this episode talk with Scott DeLoach and Mike Unwalla about Using Style Guides in Technical Communication. 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’. . SOME TOPICS WE COVERED: The difference between a brand style guide and a technical writing style guide Some of the style guides that are available and when to use them How can a style guide help you write better documentation How to create your own style guide For more information head here: https://instrktiv.com/en/style-guide-technical-writing/

Style Guides for Technical Writers, with Scott DeLoach and Mike Unwalla

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.  

How to CE Mark Machinery

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.

How to CE Mark A Product

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. As I think it is useful for companies selling medical devices on the European market, to have more insight in the certification process of medical Devices, we will talk about it in this podcast episode. In this podcast, I am interviewing Martin de Graaf, who specialises in assisting companies with the conformity assessment procedures of medical devices. 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.

How to CE Mark a Medical Device

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.

Product Safety and Information for Use from a Lawyer's Perspective

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

Using the ISO 20607 to Create Instruction Handbooks for Machinery with Martin Rieder

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.

Using the Principles of Minimalism to Create Better User Support, with Dr. Hans van der Meij

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.

The new 82079 standard on Information for Use

This Podcast covers topics related to creating user-friendly and compliant information for use. Topics such as the principles of minimalism, ISO 20607 and IEC/IEEE 82079 will be discussed.

hubhopper

Instrktiv's Insane Instructions Show

hubhopper