The Knowledge Base module is a centralized library for documentation — SOPs, manuals, guides, and how-to tutorials. It keeps your team’s knowledge organized, versioned, and accessible.
What You Can Do
- Upload and publish documents (PDFs, Word files, Excel, PowerPoint)
- Write rich-text tutorials directly in the browser
- Control document visibility by site or share across all sites
- Track document versions — every file replacement is logged
- Search documents by title, category, or description
- Export document lists to Excel
Two Types of Content
The Knowledge Base has two content types:
| Type | Description |
|---|---|
| Documents | Uploaded files — PDFs, Word docs, spreadsheets, presentations |
| Tutorials | Written guides created directly in the app using a rich-text editor |
📸 [Screenshot: Knowledge Base page — Documents and Tutorials tabs]
Uploading a Document
- Go to Knowledge Base in the left sidebar.
- Click the Documents tab.
- Click + Upload Document.
- Fill in:
- Title — display name for the document
- Category — type of document (configurable by admin)
- Description — brief summary of the content
- Visibility — who can see this document (see below)
- File — select the file to upload
- Click Save.
📸 [Screenshot: Upload Document form]
Document Visibility
Each document can be made visible to specific sites or all sites:
| Scope | Description |
|---|---|
| Specific sites | Only visible to selected site(s) |
| All sites (cluster) | Visible to all sites in the system |
This lets you share company-wide SOPs with everyone, while keeping site-specific procedures private.
Updating a Document (New Version)
When a document needs to be updated, upload the new file instead of deleting the old one. ITMKit tracks versions automatically.
- Open the document.
- Click Replace File.
- Upload the new version.
- The version number increments and the replacement date is recorded.
Staff always see the latest version. The version history is visible in the document detail.
Creating a Tutorial
Tutorials are written directly in ITMKit using a rich-text editor — no file upload needed.
- Click the Tutorials tab.
- Click + New Tutorial.
- Enter a title and category.
- Write the content using the editor (supports headings, bold, bullet lists, images, and code blocks).
- Click Publish when ready.
📸 [Screenshot: Tutorial editor]
Publishing and Unpublishing
Documents and tutorials must be Published before other users can see them. This lets you draft content before making it available.
- Draft (unpublished) — visible only to the creator and managers
- Published — visible to all users with access to that site
To publish: open the document or tutorial → click Publish.
To unpublish: click Unpublish to hide it from regular users.
Searching and Filtering
Use the search bar and category filter at the top of the page to find documents quickly.
- Search by title or description keyword
- Filter by category
- Filter by file type (PDF, Word, Excel, etc.)
Permissions
| Permission | Description | Manager | Supervisor | Staff |
|---|---|---|---|---|
| view | See published documents and tutorials | ✅ | ✅ | ✅ |
| create | Upload documents and write tutorials | ✅ | ✅ | ❌ |
| edit | Edit and update existing content | ✅ | ✅ | ❌ |
| delete | Delete documents and tutorials | ✅ | ❌ | ❌ |
| export | Export document list to Excel | ✅ | ✅ | ❌ |
| manage | Configure categories | ✅ | ❌ | ❌ |
Next Steps
→ [Admin Guide]
→ [FAQ]