2025-12-27 11:24:11 -05:00
|
|
|
# Welcome to AtomicQMS! 🚀
|
2025-12-27 11:24:10 -05:00
|
|
|
|
2025-12-27 11:24:11 -05:00
|
|
|
This interactive tutorial will teach you how to use AtomicQMS and your AI assistant, **AtomicAI**.
|
|
|
|
|
|
|
|
|
|
## What You'll Learn
|
|
|
|
|
|
|
|
|
|
1. **Understanding the QMS structure** - How documents are organized
|
|
|
|
|
2. **Using AtomicAI** - Your AI-powered documentation assistant
|
|
|
|
|
3. **Creating your first SOP** - Step-by-step document creation
|
|
|
|
|
4. **Review workflows** - Using Pull Requests for document control
|
|
|
|
|
5. **Next steps** - Choosing the right template for your needs
|
|
|
|
|
|
|
|
|
|
## How This Tutorial Works
|
|
|
|
|
|
|
|
|
|
This repository is your **personal sandbox**. You can:
|
|
|
|
|
- Create issues and mention `@atomicai` to get help
|
|
|
|
|
- Create documents and learn the workflow
|
|
|
|
|
- Make mistakes freely - this is for learning!
|
|
|
|
|
|
|
|
|
|
When you're ready for production, create a new repository from one of our specialized templates.
|
|
|
|
|
|
|
|
|
|
---
|
|
|
|
|
|
|
|
|
|
## Tutorial Steps
|
|
|
|
|
|
|
|
|
|
### Step 1: Meet AtomicAI
|
|
|
|
|
|
|
|
|
|
AtomicAI is your AI documentation assistant. Try it now:
|
|
|
|
|
|
|
|
|
|
1. Go to the **Issues** tab
|
|
|
|
|
2. Click **New Issue**
|
|
|
|
|
3. Title it "My first question"
|
|
|
|
|
4. In the body, type: `@atomicai What can you help me with?`
|
|
|
|
|
5. Submit the issue and watch AtomicAI respond!
|
|
|
|
|
|
|
|
|
|
### Step 2: Understand the Structure
|
|
|
|
|
|
|
|
|
|
Look at the folders in this repository:
|
|
|
|
|
|
|
|
|
|
```
|
|
|
|
|
├── SOPs/ # Standard Operating Procedures
|
|
|
|
|
├── Forms/ # Fillable forms and checklists
|
|
|
|
|
├── Policies/ # High-level policies
|
|
|
|
|
├── Work-Instructions/ # Detailed step-by-step guides
|
|
|
|
|
├── Templates/ # Document templates
|
|
|
|
|
└── Examples/ # Sample documents to learn from
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
### Step 3: Create Your First SOP
|
|
|
|
|
|
|
|
|
|
1. Create a new issue
|
|
|
|
|
2. Title: "Create SOP for [your topic]"
|
|
|
|
|
3. Body: `@atomicai Please create an SOP for [describe what you need]`
|
|
|
|
|
|
|
|
|
|
AtomicAI will:
|
|
|
|
|
- Create a new branch
|
|
|
|
|
- Write the SOP following best practices
|
|
|
|
|
- Submit a Pull Request for your review
|
|
|
|
|
|
|
|
|
|
### Step 4: Review and Approve
|
|
|
|
|
|
|
|
|
|
When AtomicAI creates a Pull Request:
|
|
|
|
|
1. Review the changes in the **Files changed** tab
|
|
|
|
|
2. Add comments if you want changes
|
|
|
|
|
3. Approve and merge when satisfied
|
|
|
|
|
|
|
|
|
|
This is **document control** - every change is tracked and reviewed!
|
|
|
|
|
|
|
|
|
|
### Step 5: Explore the Examples
|
|
|
|
|
|
|
|
|
|
Check out the `Examples/` folder for sample documents:
|
|
|
|
|
- A completed SOP
|
|
|
|
|
- A filled-out form
|
|
|
|
|
- Common QMS patterns
|
|
|
|
|
|
|
|
|
|
---
|
|
|
|
|
|
|
|
|
|
## Ready for Production?
|
|
|
|
|
|
|
|
|
|
When you've completed this tutorial, choose a specialized template:
|
|
|
|
|
|
|
|
|
|
| Template | Best For |
|
|
|
|
|
|----------|----------|
|
|
|
|
|
| [QMS Template](../qms-template) | General quality management |
|
|
|
|
|
| [Clinical Research](../clinical-research-template) | Clinical trials, ICH-GCP |
|
|
|
|
|
| [Laboratory Science](../laboratory-science-template) | Research labs, GLP |
|
|
|
|
|
| [Pharmacy](../pharmacy-template) | Retail/hospital pharmacy, USP |
|
|
|
|
|
|
|
|
|
|
---
|
|
|
|
|
|
|
|
|
|
## Need Help?
|
|
|
|
|
|
|
|
|
|
- Create an issue and mention `@atomicai`
|
|
|
|
|
- Check the examples in this repository
|
|
|
|
|
- Review the [AtomicQMS Documentation](#) (coming soon)
|
|
|
|
|
|
|
|
|
|
Happy documenting! 📋
|
