Hiring or looking for a job in Digital Health? Check out our Digital Health Jobs board

Articles Technical Documentation

Updated May 24, 2023

Writing Technical Documentation

Dr. Oliver Eidel

What the Hell is Technical Documentation?

The Technical Documentation (or Technical File) is what you hand in to your Notified Body to get your product certified. It’s a collection of (pdf) documents which you send them. Any time you make a significant change to your product (more on that later), you send an updated Technical Documentation to your Notified Body for approval.

This applies to each of your products. So if you want to get more than one software certified as a Medical Device, you have to submit a separate Technical Documentation for each.

This differs from your Quality Management System which is valid company-wide. This typically gets audited on-site by your Notified Body with yearly follow-up audits (fun!).

What Does Technical Documentation Include?

That’s where the chaos begins. There is no common standardized structure for Technical Documentation. But at least the content is somewhat clear. The common requirements are:

Let’s go through these briefly and see how we can fulfil them.

Software Documentation (IEC 62304)

You need to establish an IEC 62304 - compliant software development process in your company. This process has certain requirements with respect to documentation. Examples would be that you have to document your software requirements (which answer the question “what does your software do?”) and maintain a list of third-party libraries you’re using (Software of Unknown Provenance, SOUP).

I did a separate write-up about what you need to become 62304-compliant, have a look:

Article

IEC 62304 Walkthrough

Read

Risk Analysis (ISO 14971)

Risk Analysis means that you ask yourself “What could go wrong with my software?” and “What would subsequently happen to its users?”. Simple, right? Until you encounter the ISO 14971 which puts that into regulatory language and confuses the hell out of you. But that’s pretty much what it means.

The whole package is called Risk Analysis and is an important part of your Technical Documentation.

Article

ISO 14971 Walkthrough

Read

Usability Documentation (IEC 62366)

You need to be compliant with IEC 62366 which states that you implement some sort of Usability Engineering process. The main part if this is that you conduct user testing on your final product (called Summative Usability Evaluation).

Coming soon: IEC 62366 Walkthrough

On a slighty different note: You want to get your medical software certified under MDR but don't know where to start? No worries! That's why we built the Wizard. It's a self-guided video course which helps you create your documentation yourself. No prior knowledge required. You should check it out.

Or, if you're looking for the most awesome (in our opinion) eQMS software to manage your documentation, look no further. We've built Formwork, and it even has a free version!

If you're looking for human help, did you know that we also provide some limited consulting? It's limited because we are not many people. We guide startups from start to finish in their medical device compliance.

Congratulations! You read this far.

Get notified when we post something new.

Sign up for our free newsletter.

Dr. Oliver Eidel

I'm a medical doctor, software engineer and regulatory dude. I'm also the founder of OpenRegulatory.

Through OpenRegulatory, I've helped 100+ companies with their medical device compliance. While it's also my job that we stay profitable, I try to dedicate a lot of my time towards writing free content like our articles and templates. Maybe that will make consulting unnecessary some day? :)

If you're still lost and have further questions, reach out any time!

Comments

If you have any questions or would like to share your opinion publicly, feel free to comment below. If you'd like to reach out privately, send us a message.

No QMS on this planet will save you from creating crappy software.