GitHub Pages site for laboratory safety documentation including Risk Assessments and Safe Work Procedures.
SAIL-RA-SWP/
βββ index.md # Home page with auto-populating document lists
βββ laser-safety-guide.md # Class 4 laser safety guide
βββ DOCUMENTATION.md # Auto-population documentation
βββ CLAUDE_PROMPT.md # User prompts for Claude assistance
βββ SYSTEM_PROMPTS.md # System prompts for Claude Projects/API
β
βββ _risk_assessments/ # Risk Assessment documents (auto-indexed)
β βββ bambu-h2d.md # Bambu H2D Risk Assessment
β βββ 3sae-cms.md # 3SAE CMS Risk Assessment
β
βββ _safe_work_procedures/ # Safe Work Procedure documents (auto-indexed)
β βββ bambu-h2d.md # Bambu H2D SWP
β βββ 3sae-cms.md # 3SAE CMS SWP
β
βββ _templates/ # Templates for new documents
β βββ README.md # Template usage guide
β βββ risk-assessment-template.md # RA template
β βββ safe-work-procedure-template.md # SWP template
β
βββ .github/ # GitHub templates and guides
β βββ ISSUE_TEMPLATE/ # Issue templates
β β βββ new-equipment-documentation.md
β β βββ document-review.md
β β βββ safety-concern.md
β β βββ website-improvement.md
β β βββ config.yml
β βββ pull_request_template.md # PR template
β βββ CONTRIBUTING.md # Contribution guide
β
βββ _layouts/ # Jekyll layouts
β βββ default.html # Main layout with navigation
β βββ document.html # Document-specific layout
β
βββ assets/ # CSS and other assets
β βββ css/
β βββ style.css # Custom styling
β
βββ _config.yml # Jekyll configuration with collections
Visit the published site at: https://[your-username].github.io/[repository-name]/
Or run locally:
bundle install
bundle exec jekyll serveThen open http://localhost:4000 in your browser.
The index page automatically populates with new documents! You no longer need to manually edit index.md to add new Risk Assessments or Safe Work Procedures.
Just create a document in the appropriate collection folder with the required front matter fields, and it will automatically appear on the front page.
For detailed information, see DOCUMENTATION.md
-
Copy the template:
cp _templates/risk-assessment-template.md _risk_assessments/[equipment-name].md
-
Edit the new file and update the front matter:
equipment_name: "[Equipment Name]" reference: "SAIL-RA-EQUIPMENT-XXX" version: "1.0" status: "Draft" # Change to "Approved" when ready description: "[Brief description for the index card]" key_hazards: "[Main hazards]" permalink: /risk-assessments/[equipment-name]/
-
Replace all
[placeholders]with your information -
That's it! The document will automatically appear on the index page when you commit and push
-
Copy the template:
cp _templates/safe-work-procedure-template.md _safe_work_procedures/[equipment-name].md
-
Edit the new file and update the front matter:
equipment_name: "[Equipment Name]" reference: "SAIL-SWP-EQUIPMENT-XXX" version: "1.0" status: "Draft" # Change to "Approved" when ready description: "[Brief description for the index card]" includes: "[What the procedure covers]" permalink: /safe-work-procedures/[equipment-name]/
-
Replace all
[placeholders]with your information -
That's it! The document will automatically appear on the index page when you commit and push
The fastest way to create new documents is via the GitHub Issues workflow:
- Open an issue using the "New Equipment Documentation" template β fill in equipment name, manufacturer, location, hazards, PPE, and the equipment slug (e.g.,
fume-hood) - A lab member with write access reviews the issue and comments
/generate-docs - GitHub Actions calls the Claude AI API automatically and opens a draft PR containing both the RA and SWP
The PR links back to the issue and includes a review checklist. Once the documents have been reviewed and all placeholder values verified against manufacturer specs, change status: Draft to status: Approved in the front matter and merge.
One-time setup required: Add ANTHROPIC_API_KEY to the repository's GitHub Actions secrets (Settings β Secrets and variables β Actions β New repository secret). Contact the repository owner if you need access.
Important: All AI-generated content must be reviewed by a qualified person. Never approve documents without verifying technical specifications against manufacturer documentation.
You can also use Claude interactively. See:
- SYSTEM_PROMPTS.md - System prompts for Claude Projects or API integration
These prompts guide Claude to:
- Generate equipment-specific Risk Assessments with proper hazard analysis
- Create detailed Safe Work Procedures with step-by-step instructions
- Review documents for completeness and compliance
- Use Australian standards and terminology
- Follow the SAIL template format exactly
Each document template includes:
Risk Assessment Template:
- Document metadata (reference number, version, dates)
- Critical safety warnings
- Hazard identification tables
- Risk ratings and controls
- Emergency procedures
- Review schedule
Safe Work Procedure Template:
- Document metadata
- Required resources and PPE
- Step-by-step operating instructions
- Pre-operation safety checks
- Emergency shutdown procedures
- Cleanup and waste disposal
- Competency requirements and sign-off sheet
Each document has YAML front matter with metadata:
---
layout: document
title: [Document Title]
doc_type: [Risk Assessment or Safe Work Procedure]
status: [draft, approved, or archived]
permalink: /[category]/[document-name]/
metadata:
reference: SAIL-[TYPE]-[EQUIPMENT]-XXX
title: [Full Descriptive Title]
version: "1.0"
issue_date: [Month Year]
prepared_by: [Your Name]
supervisors: [Supervisor Names]
review_date: [Month Year]
critical_warning: |
[Critical safety information displayed prominently]
related_docs:
- title: [Related Document]
url: /[path]/
description: [Brief description]
show_review: true
---SAIL= SAIL LaboratoryRA= Risk AssessmentSWP= Safe Work Procedure[EQUIPMENT]= Short equipment identifier (e.g., BAMBU-H2D, LASER-001)XXX= Sequential number (001, 002, etc.)
Examples:
SAIL-RA-BAMBU-H2D-001- First Bambu H2D Risk AssessmentSAIL-SWP-BAMBU-H2D-001- First Bambu H2D Safe Work Procedure
The site uses custom CSS (assets/css/style.css) with:
- Blue headers (RGB 203, 216, 240) matching LaTeX/Word templates
- Professional table formatting
- Color-coded warning and info boxes
- Document metadata badges
- Print-friendly styles
- Responsive design for mobile/tablet
<div class="danger-box">
<h3>β οΈ CRITICAL WARNING β οΈ</h3>
<p>Critical safety information</p>
</div>
<div class="warning-box">
<h3>β οΈ Warning</h3>
<p>Important safety information</p>
</div>
<div class="info-box">
<h3>βΉοΈ Information</h3>
<p>Helpful information</p>
</div>- Push this repository to GitHub
- Go to repository Settings β Pages
- Under "Source", select the branch (usually
main) - Save and wait a few minutes
- Your site will be available at
https://[username].github.io/[repository-name]/
Edit the emergency contacts table in index.md:
| Emergency Type | Contact | Number |
|---------------|---------|---------|
| **Emergency Services** | Fire, Medical, Police | **000** |
| **Supervisor** | Chris Betters | [Insert number] |Edit _layouts/default.html to modify the navigation menu:
<nav>
<ul>
<li><a href="/">Home</a></li>
<li><a href="/#risk-assessments">Risk Assessments</a></li>
<li><a href="/#safe-work-procedures-swps">Safe Work Procedures</a></li>
<li><a href="/laser-safety-guide">Resources</a></li>
</ul>
</nav>Edit color variables in assets/css/style.css:
:root {
--header-blue: rgb(203, 216, 240);
--text-color: #333;
--border-color: #000;
}All safety documents must be reviewed:
- Annually at minimum
- After any incident or near-miss
- When procedures change
- When equipment is modified
- When new hazards are identified
Update the review_date in document front matter when reviewed.
draft- Work in progress, not yet approvedapproved- Reviewed and approved for usearchived- Superseded by newer version
- Create new document from template
- Complete all sections, replacing placeholders
- Consult with stakeholders (users, safety officer, etc.)
- Review for accuracy and completeness
- Approve by supervisor and safety officer
- Publish by updating status to "approved"
- Add to index.md document list
- Train all users on the new/updated procedure
- Display near relevant equipment
- Review annually or as needed
- These are safety-critical documents
- Always refer to the latest approved version
- Contact supervisor or safety officer with any questions
- Do not operate equipment without proper training and authorization
- Complete all mandatory pre-operation safety checks
- Never defeat or bypass safety systems
- Supervisor: Chris Betters
- Safety Officer: [Insert details]
- Emergency Services: 000
- University Security: [Insert number]
CLASS 4 LASER EQUIPMENT - Most hazardous laser classification
Documents available:
- Risk Assessment (SAIL-RA-BAMBU-H2D-001)
- Safe Work Procedure (SAIL-SWP-BAMBU-H2D-001)
- Laser Safety Guide
Mandatory training and authorization required before use.
These safety documents are provided for the safe operation of laboratory equipment. Unauthorized modification or use may compromise safety. All documents should be reviewed and approved by appropriate safety personnel before implementation.
School of Physics | University of Sydney | SAIL Laboratory