π Nanofab Documentation Structure and Versioning Protocol¶
This document outlines the standard operating procedure for storing, organizing, and versioning all nanofabrication-related documents using Google Drive and Google Docs.
π Folder Structure¶
All documents will reside within a main shared folder in Google Drive, organized by tool and audience:
Nanofab Docs/
βββ [TOOL NAME OR ID]/
β βββ User Docs/
β β βββ TOOLID_User_SOP_v1.0
β β βββ ...
β βββ Staff Docs/
β β βββ TOOLID_Staff_Maintenance_v1.0
β β βββ ...
β βββ TOOLID_ChangeLog (Google Sheet or Doc)
β
βββ [Another Tool]/
β βββ ...
Each tool should have:
- User Docs: SOPs and training materials for facility users
- Staff Docs: Internal guides, maintenance procedures, troubleshooting
- ChangeLog: A log of version updates with summaries
π Document Naming Convention¶
Use the following naming format:
[TOOLID]_[Audience]_[DocumentType]_v[Major.Minor]
Examples:¶
EBL-02_User_SOP_v2.1RIE-01_Staff_MaintenanceChecklist_v1.0-
ALD-03_User_SafetyGuide_v3.2 -
TOOLID: Unique short name for each tool (e.g.,
SEM-01,ALD-03) - Audience:
UserorStaff - DocumentType: SOP, SafetyGuide, Checklist, etc.
- vX.Y: Semantic version (e.g., v2.1 = second major version, first minor update)
π Versioning Protocol (Google Docs)¶
Use Google Docs' built-in version history to manage and annotate meaningful changes.
How to Save a Named Version:¶
- Open the Google Doc
- Go to: File β Version History β Name current version
- Use the format:
v2.1 β Updated rinse time; clarified PPE section - Press Enter. This version will now be saved and accessible via: File β Version History β See version history
π Do NOT rename the Google Doc filename for every update.
Use named versions instead.
π οΈ When to Create a New Version¶
Create a new named version when: - A procedure step changes - Safety or chemical information changes - Equipment configuration changes - Training or permission access changes
Do not create a new version for: - Typos or formatting - Clarifying language that doesn't affect procedure
π Additional Guidelines¶
- File names should only change when the published version changes (e.g., from
v2.1tov2.2) - Keep all versions in the same folder
- Optional: maintain an alias document like
EBL-02_User_SOP_latestthat links to the current official version - Use the
ChangeLogdocument to track updates across all files in the tool folder
β Summary¶
- Organized by tool β audience β document
- Named with consistent, versioned format
- Version history tracked inside Google Docs (named versions)
- Optional
ChangeLogper tool folder for transparency
π Transition to Google Workspace for Nanofab Docs¶
π― Purpose¶
This document explains why we are transitioning from a shared Gmail login to a more secure, scalable setup using Google Workspace (Business Standard) with proper shared access. This will improve: - Document control and security - Version tracking by individual - Stable long-term file ownership - Ease of collaboration without account sharing
π§Ύ Summary of Options Considered¶
| Option | Pros | Cons |
|---|---|---|
| Shared Gmail login | Free, simple | π« Insecure, violates ToS, no user tracking |
| Google Drive shared folders | Secure, free with personal Gmail accounts | π« Files still owned by individual users |
| Google Workspace + Shared Drives | β Central ownership, access control, scalable | π² Requires Business Standard ($12/mo/user) |
β Our New Setup¶
We are using:
- 1 paid Google Workspace Business Standard account: docs@nanofabninjas.com
- Shared Drives created and owned by this account
- All SOPs and documents will be stored in these Shared Drives
- Team members will access content using their personal Gmail accounts
This gives us: - Centralized file ownership (even if staff come/go) - Role-based permissions (viewer, editor, etc.) - No more shared login risk
π Shared Drive Structure¶
Each tool will have a folder inside the Shared Drive:
Nanofab Shared Drive/
βββ EBL-02/
β βββ User Docs/
β βββ Staff Docs/
β βββ EBL-02_ChangeLog
βββ ALD-03/
β βββ ...
π οΈ How to Set Up (Admin Instructions)¶
- Create a Google Workspace account at: https://workspace.google.com
- Select Business Standard plan ($12/mo)
- Use your domain or get one during sign-up (optional)
- After setup:
- Go to Google Drive β Shared Drives β Create Drive
- Name it something like
Nanofab Docs -
Create folders for each tool inside
-
Invite team members to the Shared Drive by their personal Gmail addresses, and assign roles:
- Viewer (read-only)
- Commenter (can suggest changes)
- Editor (can make changes)
- Manager (admin rights)
π©βπ¬ Staff Instructions¶
Dear team,
We are moving away from sharing a single Google login. Each of you will now use your own Gmail address to access our documentation.
π Here's What You Need to Do:¶
- Make sure you have a personal Gmail account.
- You will receive an invite to the "Nanofab Docs" Shared Drive from
docs@nanofabninjas.com. - Accept the invite and bookmark the Shared Drive for easy access:
- Go to https://drive.google.com/drive/shared-drives
- Look for βNanofab Docsβ
- Youβll be given the appropriate level of access (View / Edit / Comment).
- Do not make copies of files unless requested.
- All edits will now show your name, which helps us track changes and improve transparency.
π¦ Why This Change?¶
- We can manage permissions safely and professionally
- Edits will be tracked by person and timestamp
- Files are protected even if a staff member leaves
- It's compliant with Googleβs terms of service
π¬ Questions?¶
Please contact docs@nanofabninjas.com if:
- You didn't receive your invite
- Youβre unsure of your access level
- You need help accessing a document