R-002-007 Process validation card 2023_011
Version control
| Reason for review | Date | Version id | Change |
|---|---|---|---|
| Initial creation | 20230308 | 1 | N/A |
| Management Review 2024 | 20240415 | 2 | Annual revalidation |
| Management Review 2025 | 20250415 | 3 | Annual revalidation |
| Update | 20260223 | 4 | Added Docusaurus/Turborepo/Firebase and risk analysis section |
Process
Operations
Requirements
To develop a Quality Management System and regulatory documentation (IFUs, Investigator Manuals) that allows accessibility, scalability, customization, security, version control and integration.
Selection description
Developing a Quality Management System (QMS) and regulatory documentation as web applications offers several advantages for us:
-
Accessibility: By developing our QMS as a web-based application, it can be accessed from anywhere with an internet connection, which can be useful for remote teams or employees who need to access the system while on the go.
-
Scalability: A web-based application QMS can be easily scaled up or down as needed, without the need for physical infrastructure or hardware upgrades.
-
Customization: A webpage-based QMS can be easily customized to suit the specific needs of our organization, with different features and modules added or removed as needed.
-
Security: A webpage-based QMS can be secured using encryption, authentication, and access controls to protect sensitive information and prevent unauthorized access.
-
User-Friendly: A webpage-based QMS can be designed to be user-friendly and intuitive, with clear navigation and easily accessible resources and tools.
-
Integration: A webpage-based QMS can be integrated with other tools and systems, such as databases or reporting tools, which can help to streamline workflows and improve efficiency.
Additionally, we have chosen to use Git alongside Markdown programming language (to make it easy to read, write, and edit prose) to develop our quality management system as a web-based application, through the GitHub Microsoft tool selected (see R-002-007 Process validation card 2023_017), as it has the following characteristics:
-
Collaboration: GitHub enables team members to work on the same codebase simultaneously and merge changes together, facilitating collaboration and improving teamwork.
-
Version Control: GitHub provides a history of all changes made to the code, allowing developers to track the evolution of the code over time, identify bugs, and roll back to previous versions if needed.
-
Code Review: GitHub supports code review workflows, allowing other team members to review changes to the code and ensure they meet quality standards.
-
Branching: GitHub allows for the creation of branches, which can be used for development and testing of new features without affecting the main codebase. This can help to reduce risk and improve code quality.
-
Integration: GitHub can be integrated with other tools and services, such as continuous integration and deployment tools, which can help to automate the build and testing process and improve the efficiency of the development process.
-
Web Development: Using programming languages such as JavaScript, HTML, and CSS to develop our quality management system as a webpage can provide a user-friendly interface that can be accessed from anywhere with an internet connection.
Technical stack
The following tools and frameworks are used to build and deploy our web-based documentation system:
| Tool | Purpose | Version |
|---|---|---|
| Docusaurus | Static site generator that transforms Markdown/MDX into web applications | 3.x |
| Turborepo | Monorepo build system that manages multiple applications (QMS, IFUs, Investigator Manuals) in a single repository | Latest |
| Firebase Hosting | Cloud hosting platform for deploying Investigator Manuals with access control | N/A |
| Node.js | JavaScript runtime for building and running the applications | 18.x+ |
Docusaurus
Docusaurus is a static site generator developed by Meta (Facebook) that converts Markdown and MDX files into fully functional web applications. Key characteristics:
- Markdown/MDX support: Content is written in Markdown with React component support (MDX), enabling rich, interactive documentation while maintaining readability of source files.
- Versioning: Built-in document versioning allows us to maintain multiple versions of IFUs and other regulatory documents.
- Search: Integrated search functionality for easy navigation of documentation.
- Internationalization (i18n): Native support for multiple languages, essential for EU IFUs requiring translations.
- PDF generation: Integration with docs-to-pdf plugin enables generation of PDF versions for regulatory submissions.
- Theming and customization: Fully customizable appearance to match branding requirements.
- Active maintenance: Backed by Meta with regular updates and security patches.
Turborepo
Turborepo is a high-performance build system for JavaScript/TypeScript monorepos. We use it to manage all our documentation applications in a single repository:
- Monorepo structure: Single repository containing QMS, EU IFU (MDR/MDD), US IFU (FDA), Investigator Manuals, and Website.
- Shared packages: Common components, styles, and configurations are shared across all applications, ensuring consistency.
- Incremental builds: Only rebuilds what has changed, significantly reducing build times.
- Task orchestration: Manages dependencies between build tasks across multiple applications.
The monorepo includes the following applications:
apps/qms- Quality Management Systemapps/eu-ifu-mdr- EU Instructions for Use (MDR)apps/eu-ifu-mdd- EU Instructions for Use (MDD)apps/us-ifu-fda- US Instructions for Use (FDA)apps/investigator-manual-*- Clinical study Investigator Manualsapps/website- Public website
Firebase Hosting
Firebase Hosting is used specifically for deploying Investigator Manuals that require access control:
- Access control: Firebase Authentication integration enables restricted access to clinical study documentation.
- HTTPS by default: All content served over secure connections.
- Global CDN: Fast content delivery worldwide.
- Easy deployment: Integrated with our CI/CD pipeline for automated deployments.
Validation
Developing a QMS as a web-based application offers several advantages, including accessibility, scalability, customization, security, user-friendliness, and integration. By leveraging these advantages, we improve the efficiency and effectiveness of our quality management processes and ultimately deliver better products or services to our customers.
In addition, Git version control system allows us collaboration, version control, code review, branching, integration, and web development capabilities.
The technical stack (Docusaurus + Turborepo + Firebase) has been validated through:
- Continuous use since 2023: The system has been in production use, demonstrating stability and reliability.
- Regulatory submissions: Documentation generated by this system has been successfully used in regulatory submissions.
- Audit trail: Full version history maintained through Git, meeting 21 CFR Part 11 requirements (see
R-002-007 Process validation card 2023_017). - PDF generation: Validated capability to generate PDF outputs for regulatory submissions.
Identified risks
| Risk | Potential impact | Control measure | Status |
|---|---|---|---|
| Docusaurus major version update breaks compatibility | Documentation build failure | Pin major versions, test updates in development branch before merging | Controlled |
| Firebase service outage | Investigator manuals temporarily unavailable | Monitor Firebase status, alternative PDF distribution available | Controlled |
| Dependency vulnerabilities | Security risk | Automated dependency scanning (Dependabot), regular updates | Monitoring |
Record signature meaning
- Author: JD-004
- Review and approval: JD-001 ㅤ ㅤ