Welcome to AtomicQMS! 🚀

This interactive tutorial will teach you how to use AtomicQMS and your AI assistant, AtomicAI.

What You'll Learn

Understanding the QMS structure - How documents are organized
Using AtomicAI - Your AI-powered documentation assistant
Creating your first SOP - Step-by-step document creation
Review workflows - Using Pull Requests for document control
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:

Go to the Issues tab
Click New Issue
Title it "My first question"
In the body, type: @atomicai What can you help me with?
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

Create a new issue
Title: "Create SOP for [your topic]"
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:

Review the changes in the Files changed tab
Add comments if you want changes
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	General quality management
Clinical Research	Clinical trials, ICH-GCP
Laboratory Science	Research labs, GLP
Pharmacy	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! 📋

2.8 KiB Original text Edit trail Version history File Word PDF