Documentation, knowledge base and assets
Video guide: Choose customer documentation and prepare an internal KB article
Recorded October 22, 2026 in the fictional Summit Managed IT staging workspace, App 0.432.1. The deployed demo can differ from the current product; use the written guide for current behavior. Unsaved internal KB draft; no saved document version, asset import or portal publication is demonstrated.
Full narration captions are included in the video. Open video full screen · Download subtitles · Download transcript
Video transcript
Open Clients, Documentation. The customer picker controls whose runbooks and login records you are viewing. Switch to Northwind Traders and check the heading. This fictional workspace is empty. Never put a real customer password into a training recording.
Customer documentation holds structured items and edit history. The Knowledge Base is a separate article workflow with internal and client-facing visibility. Open Knowledge Base, then New article. Choose the intended audience before writing a reusable resolution.
Type a fictional title and a short checklist: confirm the customer, read last-seen time, then verify a later heartbeat. Keep visibility Internal. We leave Publish article untouched. Before publishing real material, remove credentials and customer details, review audience permissions, and test the article as the intended reader.
Video guide: Create, reopen, edit and delete an internal KB article
Recorded October 22, 2026 in the fictional Summit Managed IT staging workspace, App 0.432.1. The deployed demo can differ from the current product; use the written guide for current behavior. Creates and edits one fictional Internal article in the recorded staging workspace, then deletes that exact training article. Client-facing access, customer document versions and asset import are not tested.
Full narration captions are included in the video. Open video full screen · Download subtitles · Download transcript
Video transcript
Open Knowledge Base, then New article. This is the fictional Summit Managed IT staging workspace. We will save an internal training article, reopen it, edit it, and delete only the article created in this take. This does not test customer portal access.
Type a recognizable training title and a short checklist for verifying device reporting. Keep visibility Internal, staff only, and press Publish article. Confirm the saved title, the Internal badge and the rendered checklist. This saves an article; it does not verify an actual endpoint heartbeat.
Return to the Knowledge Base list and open the exact training title. Reading it again from the list checks that the article persisted rather than remaining only in the editor. Confirm the title and internal visibility before editing.
Open Edit and add a fourth checklist item: record the observed time and result. Leave visibility Internal and press Save changes. Confirm the new item on the rendered article. These are knowledge-base edits; customer-document version history and restoration are different workflows.
Delete the exact fictional article created in this recording and accept its confirmation. Back in the list, verify the training title is absent. The demonstration leaves no training article behind. Deleting real documentation needs the appropriate retention and recovery decision.
Documentation (Clients > Documentation)
What it does: an IT Glue style workspace per customer: an Accounts and Logins tab with encrypted secrets, and user-defined sections holding notes, markdown documents, tables and checklists, with related-item links (device, asset, document, login), version history with preview and restore, organization-wide search, and CSV, Excel and PDF export.
How it works: stored login secrets are encrypted at rest and revealed through an audited endpoint that logs a System activity per reveal; documentation exports include decrypted login passwords and hidden API values, with revealed-secret counts audited. Handle these files as credentials. The portable workspace business-record JSON export is separate and omits credential models. Free-text notes and documents are not secret fields: keep passwords out of text you intend to export or share. Documents keep the last 50 revisions; a revision can be previewed, restored, deleted, or the history cleared. Client administrators can add sections and add or edit notes, documents, tables and checklists for their own organization in the portal. They can also add and edit Accounts and Logins entries, including the password, for their own organization and reveal stored passwords there; each customer reveal is recorded in the activity log separately from staff reveals. Deletes, renames, restoring earlier versions and the recycle bin stay with the MSP.
Steps:
- Clients > Documentation > pick the organization.
- Accounts and Logins > Add entry: name, username, secret, URL, notes. Reveal and Copy are per entry.
- Add section (for example Network, Vendors, Procedures) then add a note, document, table (own columns, up to 12 by 500) or checklist.
- Link related items from the item's sidebar. Export from the header.
Imports, stored connection details and recovery
Use Import in the documentation workspace to preview supported files before adding them to the selected customer. Check the destination organization and review imported content before sharing it. API and SMTP entries store connection details; saving one does not establish that the external service is connected or monitored.
Deleted sections, items and login entries go to the recycle bin for 30 days and can be restored there. Delete forever and expiry are permanent; the recycle bin is not a backup. Existing revision history is available on the selected item or login entry.
Knowledge base (Clients > Knowledge Base)
Articles written by the MSP for technicians and, when published to the portal, for customers. A ticket can be turned into an article with Save as KB article.
Steps: New article, title, visibility (Internal or Client-facing), body (markdown), then Publish article.
Assets (Org page > Assets, portal Assets)
What it does: the customer's inventory in one table: managed computers as live rows (make, model, serial, IP from the agent), SNMP nodes as read-only rows with the identity the poller stamped, and manual assets (switch, phone, access point, printer, router, firewall, NVR, camera, NAS, AV equipment, other) with location, tags and notes. Filter by type, location, tag and text; export CSV, Excel and PDF (portal exports are available to every client role).
Steps: Org page > Assets > Add asset (overlay): type, name, make, model, serial, location, tags, notes. Edit inline. Managed and SNMP rows update themselves.
Custom fields for devices, customers and sites
Administration > Devices > Custom Device Fields defines fields for devices, customers and sites. Owners and Admins define fields; Owners and Admins set values, and technicians set values only for the customers they manage. The type, the script key and what a field belongs to cannot be changed after it is made.
- Add a field: name, type (Text, Number, Yes or no, or Date), what it belongs to (devices, customers or sites), an optional default and whether it is required. A device field can also let a script fill its value through a script key.
- Set device values on each device's Lifecycle tab.
- Set customer and site values from the customer page: Custom fields opens Customer fields and Site fields for that customer.
- A field with no value shows its default.
- A required field without a value is flagged as Required, not set, and the customer's Custom fields button shows how many required values are missing. Saving other changes is not blocked.
- Deleting a field also deletes its values.
Questions RevAssist could not answer from an article
When help articles are enabled, Clients > Knowledge Base shows Asked of RevAssist with no help article: chats from the last 30 days that RevAssist answered without a matching client help article, with the ticket, customer and date.
- Open the ticket to read what the user asked.
- Choose Write article to start a new article from that ticket.
- Publish it as Client-facing so RevAssist can give its steps to the next user who asks.
Verification
- A revealed login appears in Monitoring > System with the user who revealed it. Check exports with a non-sensitive test entry before sharing customer records.
- A new SNMP node shows up in Assets after its first poll with make and model.
