Skip to main content

IT Documentation

CMDB's documentation system provides versioned, rich-text IT documentation with support for wikis, runbooks, SOPs, policies, diagrams, and checklists. Link documents to companies and CIs for contextual access during ticket resolution.

Document Types​

TypeUse For
WikiGeneral knowledge articles and reference documentation
RunbookStep-by-step procedures for recurring tasks (server restarts, backup verification)
SOPStandard operating procedures for compliance and consistency
PolicySecurity policies, acceptable use policies, change management policies
DiagramNetwork diagrams, architecture drawings, data flow documentation
ChecklistOnboarding checklists, deployment checklists, audit procedures

Creating a Document​

  1. Navigate to Documents in the sidebar
  2. Click New Document
  3. Select a Document Type
  4. Enter a Title
  5. Optionally link to a Company and/or CI
  6. Write content using the rich text editor (TipTap-based with headings, lists, tables, code blocks, and links)
  7. Add Tags and a Category for organization
  8. Click Save

Versioning​

Every time you save changes to a document, the version number increments automatically. This gives you a complete history of edits without manual version management.

  • Version numbers increment on each update
  • Previous versions are retained for audit purposes
  • The current version is always displayed at the top of the document

Templates​

Create reusable templates to standardize documentation across your organization:

  1. Navigate to Templates in the sidebar
  2. Click New Template
  3. Select a Document Type
  4. Write the template content with placeholder sections
  5. Mark it as a template
  6. Click Save

When creating a new document, select a template to pre-fill the content. This ensures consistent structure across all client documentation.

💡

Create templates for your most common documentation tasks: new client onboarding runbook, network documentation wiki, quarterly review checklist, and security policy template.

Review Tracking​

Documents can have a review interval (in days) to ensure documentation stays current:

  1. Open a document and set Review Interval (e.g., 90 days)
  2. CMDB tracks last_reviewed_at and flags documents overdue for review
  3. The Staleness Report lists all documents not updated in 180+ days
⚠️Stale Documentation:

Outdated documentation is worse than no documentation — technicians may follow incorrect procedures. Use review intervals and the staleness report to keep documentation current.

Linking Documents to CIs​

Documents linked to a CI appear on that CI's detail page, giving technicians immediate access to relevant documentation when investigating an asset.

  1. When creating or editing a document, select a CI from the dropdown
  2. The document now appears in the CI's Related Documents section
  3. Multiple documents can link to the same CI

Next Steps​