Sync template from atomicqms-style deployment

This commit is contained in:
2025-12-27 11:24:11 -05:00
parent 81fb42449b
commit b1c2361b66
9 changed files with 320 additions and 2 deletions

View File

@@ -0,0 +1,74 @@
name: AtomicAI Tutorial Assistant
on:
issue_comment:
types: [created]
issues:
types: [opened, assigned]
pull_request:
types: [opened, synchronize, assigned]
pull_request_review_comment:
types: [created]
jobs:
claude-assistant:
runs-on: ubuntu-latest
if: |
github.actor != 'atomicqms-service' &&
(
(github.event_name == 'issue_comment' && contains(github.event.comment.body, '@atomicai') && github.event.comment.user.login != 'atomicqms-service') ||
(github.event_name == 'issues' && github.event.action == 'opened' && contains(github.event.issue.body, '@atomicai')) ||
(github.event_name == 'pull_request' && github.event.action == 'opened' && contains(github.event.pull_request.body, '@atomicai')) ||
(github.event_name == 'pull_request_review_comment' && contains(github.event.comment.body, '@atomicai') && github.event.comment.user.login != 'atomicqms-service') ||
(github.event.action == 'assigned' && github.event.assignee.login == 'atomicai')
)
permissions:
contents: write
issues: write
pull-requests: write
steps:
- uses: actions/checkout@v4
with:
fetch-depth: 0
- name: Run AtomicAI Tutorial Assistant
uses: https://beta.atomicqms.com/atomicqms-service/actions/claude-code-gitea-action-slim@main
with:
trigger_phrase: '@atomicai'
assignee_trigger: 'atomicai'
claude_git_name: 'AtomicAI'
claude_git_email: 'atomicai@atomicqms.local'
custom_instructions: |
You are AtomicAI, a friendly tutorial assistant helping users learn AtomicQMS.
## Your Role
This is a TUTORIAL repository. Be extra helpful and educational:
- Explain concepts as you work
- Point out best practices
- Suggest next learning steps
- Be encouraging and patient
## Document Guidelines
- Place SOPs in SOPs/
- Place Forms in Forms/
- Place Policies in Policies/
- Place Work Instructions in Work-Instructions/
- Reference examples in Examples/ when helpful
- Use templates from Templates/ as starting points
## Numbering Convention
- POL-XXX for Policies
- SOP-XXX for Standard Operating Procedures
- WI-XXX for Work Instructions
- FRM-XXX for Forms
When creating documents, always:
1. Create a branch
2. Submit as Pull Request
3. Explain what you did and why
Remind users this is a sandbox - they can experiment freely!
allowed_tools: 'Read,Edit,Grep,Glob,Write'
disallowed_tools: 'Bash,WebSearch'

View File

@@ -0,0 +1,89 @@
# SOP-001: Document Control Procedure
## Document Information
| Field | Value |
|-------|-------|
| **Document ID** | SOP-001 |
| **Version** | 1.0 |
| **Effective Date** | 2024-01-15 |
| **Review Date** | 2025-01-15 |
| **Author** | Quality Manager |
| **Approved By** | Director of Quality |
## 1. Purpose
This Standard Operating Procedure establishes the process for creating, reviewing, approving, and managing quality management system documents.
## 2. Scope
This procedure applies to all controlled documents within the Quality Management System, including:
- Policies
- Standard Operating Procedures (SOPs)
- Work Instructions
- Forms and Templates
## 3. Responsibilities
### 3.1 Document Author
- Draft new documents or revisions
- Submit documents for review via Pull Request
- Address reviewer feedback
### 3.2 Document Reviewer
- Review documents for accuracy and completeness
- Provide feedback within 5 business days
- Approve or request changes
### 3.3 Quality Manager
- Maintain document numbering system
- Ensure documents are properly archived
- Coordinate annual document reviews
## 4. Procedure
### 4.1 Creating a New Document
1. Create a new branch from `main`
2. Use the appropriate template from `/Templates`
3. Assign a document number following the convention:
- POL-XXX for Policies
- SOP-XXX for Standard Operating Procedures
- WI-XXX for Work Instructions
- FRM-XXX for Forms
4. Complete all required sections
5. Submit a Pull Request for review
### 4.2 Document Review Process
1. Assign at least one reviewer to the Pull Request
2. Reviewers have 5 business days to complete review
3. Address all feedback before merging
4. Obtain required approvals
5. Merge to `main` branch
### 4.3 Document Revision
1. Create a new branch from `main`
2. Update the version number
3. Document changes in the Revision History section
4. Follow the standard review process
## 5. Document Numbering
| Type | Format | Example |
|------|--------|---------|
| Policy | POL-XXX | POL-001 |
| SOP | SOP-XXX | SOP-001 |
| Work Instruction | WI-XXX | WI-001 |
| Form | FRM-XXX | FRM-001 |
## 6. Revision History
| Version | Date | Author | Changes |
|---------|------|--------|---------|
| 1.0 | 2024-01-15 | Quality Manager | Initial release |
---
*This is an example SOP for training purposes. Customize for your organization's needs.*

0
Forms/.gitkeep Normal file
View File

0
Policies/.gitkeep Normal file
View File

View File

@@ -1,3 +1,97 @@
# getting-started
# Welcome to AtomicQMS! 🚀
This interactive tutorial will teach you how to use AtomicQMS and your AI assistant, **AtomicAI**.
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! 📋

0
SOPs/.gitkeep Normal file
View File

0
Templates/.gitkeep Normal file
View File

61
Templates/SOP-Template.md Normal file
View File

@@ -0,0 +1,61 @@
# SOP-XXX: [Title]
## Document Information
| Field | Value |
|-------|-------|
| **Document ID** | SOP-XXX |
| **Version** | 1.0 |
| **Effective Date** | [Date] |
| **Review Date** | [Date + 1 year] |
| **Author** | [Name] |
| **Approved By** | [Name] |
## 1. Purpose
[Describe the purpose of this procedure]
## 2. Scope
[Define what this procedure covers and any limitations]
## 3. Responsibilities
### 3.1 [Role 1]
- [Responsibility]
- [Responsibility]
### 3.2 [Role 2]
- [Responsibility]
- [Responsibility]
## 4. Definitions
| Term | Definition |
|------|------------|
| [Term] | [Definition] |
## 5. Procedure
### 5.1 [Step Category]
1. [Step]
2. [Step]
3. [Step]
### 5.2 [Step Category]
1. [Step]
2. [Step]
3. [Step]
## 6. References
- [Reference 1]
- [Reference 2]
## 7. Revision History
| Version | Date | Author | Changes |
|---------|------|--------|---------|
| 1.0 | [Date] | [Name] | Initial release |

View File