Q1. How do you perform version control in ITSM documentation?
Version control in ITSM documentation is crucial for maintaining accuracy, tracking changes, and ensuring compliance. It involves managing different versions of documents such as process guides, SOPs, runbooks, and knowledge base articles. Here’s how version control is typically implemented:
1. Traditional Document Versioning (FrameMaker, Oxygen XML, SharePoint)
For teams using tools like Adobe FrameMaker, Oxygen XML Editor, or SharePoint:
Manual Versioning: Assign version numbers (e.g., v1.0, v1.1, v2.0) to PDFs, Word docs, or XML files.
Check-In/Check-Out: Ensures only one person edits at a time.
Metadata & Revision Logs: Tracks changes within document properties.
2. Document Management in ITSM Tools
ITSM platforms like ServiceNow, BMC Helix, and Jira Service Management often have built-in knowledge base (KB) versioning:
Article Versioning: ServiceNow’s KB versioning keeps track of published, draft, and archived versions.
Approval Flows: Ensures updates follow ITSM governance policies.
Automation & API Integration: Syncs KB articles with external repositories for consistency.
3. Using a CCMS (Component Content Management System)
For structured content like DITA-based ITSM documentation, a CCMS (e.g., IXIASOFT, Astoria, Vasont, Heretto) provides:
Versioning & History Tracking: Each topic or document has a unique version with a change history.
Branching & Merging: Allows parallel work on different versions (e.g., updating documentation for a new ITSM tool release while maintaining an older version).
Approval Workflows: Ensures compliance and review before publishing.
Audit Trails: Maintains records of edits, making it useful for ITIL compliance.
4. Git-Based Version Control (DITA-OT, Markdown, or Code-Driven Docs)
For teams managing ITSM documentation as code (e.g., DITA-OT-based docs, Markdown in a DevOps setting), Git repositories (GitHub, GitLab, Bitbucket) help with:
Branching & Tagging: Creating branches for updates while keeping stable versions.
Commit History: Tracking changes with timestamps and contributors.
Pull Requests (PRs) & Reviews: Ensuring updates are reviewed before merging.
5. Best Practices for ITSM Documentation Version Control
Define Versioning Strategy: Major (1.0, 2.0) vs. minor updates (1.1, 1.2).
Automate Where Possible: Use CI/CD for publishing structured docs.
Maintain Change Logs: Document modifications for audits and compliance.
User Access Control: Restrict who can edit and approve documents.
————————————————————————————————————————————–
Q2. ITSM documentation tools and methodologies you used?
ITSM Documentation Tools and Methodologies
ITSM (IT Service Management) documentation involves creating, managing, and maintaining documents such as SOPs, process guides, service catalogues, and knowledge base (KB) articles. The right combination of tools and methodologies ensures that documentation is accurate, accessible, and aligned with ITIL best practices.
1. ITSM Documentation Tools
A. ITSM Platform Documentation Tools
These are built-in or integrated tools within ITSM platforms like ServiceNow, BMC Helix, and Jira Service Management.
ServiceNow Knowledge Management
- Provides version control, workflows, and approvals.
- Uses AI-powered search and article feedback for continuous improvement.
- Supports integrations with external repositories.
BMC Helix Knowledge Management
- ITIL-aligned KB with lifecycle management and federated search.
- Supports multi-language content for global ITSM teams.
- Jira Service Management (JSM) + Confluence
- JSM integrates with Confluence to manage ITSM knowledge base articles.
- Allows linking KB articles to incidents and change requests.
B. CCMS (Component Content Management Systems) for Structured Documentation
For ITSM teams using DITA XML, CCMS platforms provide:
IXIASOFT CCMS – Version control, branching, and ITSM content reuse.
Astoria, Vasont, Heretto – Multi-channel publishing and content lifecycle management.
Oxygen XML + Git – Ideal for teams using DITA-OT for ITSM documentation.
C. Help Authoring & Technical Writing Tools
For creating ITSM process guides, SOPs, and help documentation:
MadCap Flare – Single-sourcing, topic-based content, PDF/HTML outputs.
Adobe FrameMaker – Best for large ITSM process documents in PDF.
Microsoft SharePoint & OneDrive – Internal IT teams use it for document collaboration.
D. Knowledge Management & ITSM Wiki Tools
For self-service knowledge bases and internal IT documentation:
MediaWiki / Wiki.js – Open-source wikis for ITSM process documentation.
Guru / Notion – Internal IT documentation with collaborative features.
SharePoint – Often used for storing SOPs and ITSM process documents.
2. ITSM Documentation Methodologies
A. ITIL-Based Documentation Approach
ITIL (Information Technology Infrastructure Library) provides a structured approach to ITSM documentation:
Incident Management Docs – Troubleshooting guides, KB articles.
Change Management Docs – RFC templates, impact assessments.
Service Catalog – Detailed descriptions of IT services and SLAs.
Runbooks & SOPs – Standardized operational procedures.
B. DITA (Darwin Information Typing Architecture) for ITSM Documentation
Topic-Based Authoring – Reuse content across multiple ITSM processes.
Modular & Structured – Ideal for service catalogs and knowledge bases.
Automated Publishing – Publish ITSM docs in multiple formats (PDF, HTML, XML).
C. Agile & DevOps Documentation Approach
For ITSM teams working in Agile or DevOps environments:
Docs-as-Code – Store ITSM documentation in Git (e.g., Markdown, AsciiDoc).
CI/CD Automation – Automate ITSM documentation updates with pipelines.
Continuous Documentation – Update ITSM guides alongside system changes.
D. Knowledge-Centered Service (KCS) Approach
For maintaining an effective ITSM knowledge base:
Shift-Left Strategy – Promote self-service with knowledge articles.
Article Lifecycle – Create, improve, and retire ITSM documentation based on usage.
AI & Chatbot Integration – Use AI to suggest relevant KB articles.
Best Practices for ITSM Documentation
✔ Use structured authoring for consistency.
✔ Automate workflows and approvals.
✔ Keep ITSM documentation aligned with ITIL.
✔ Integrate with ITSM platforms for real-time updates.
✔ Enable feedback loops to improve content over time.
———————————————————————————————————————————–
Q3. ITSM Documentation CMS you have used?
ITSM Documentation CMS (Content Management Systems)
A Content Management System (CMS) for ITSM documentation is essential for organizing, storing, and delivering technical documentation such as knowledge base (KB) articles, SOPs, service catalogs, and process guides. Depending on the needs (structured authoring, automation, integrations), different CMS solutions are used in ITSM environments.
1. Types of CMS for ITSM Documentation
A. CCMS: Structured ITSM and Docs
A CCMS (Component CMS) is ideal for DITA XML-based ITSM documentation, providing structured content reuse and automation.
✅ Best for: ITSM documentation teams using structured authoring and multi-channel publishing.
IXIASOFT CCMS – Enterprise-grade DITA-based CMS with strong versioning and workflow controls.
Heretto CCMS – Cloud-based CCMS with API content delivery.
Astoria CCMS – Supports large-scale ITSM documentation with structured authoring.
Vasont CCMS – Multi-channel publishing and content reuse for ITSM processes.
B. ITSM Platform Knowledge Management Systems (KMS)
These are built into ITSM platforms like ServiceNow, BMC Helix, and Jira Service Management for managing knowledge base (KB) articles.
✅ Best for: IT support teams managing ITIL knowledge bases.
ServiceNow Knowledge Management – AI-powered KB with workflows and approvals.
BMC Helix Knowledge Management – Federated knowledge search and ITIL compliance.
Jira Service Management + Confluence – KB management integrated with service desk tickets.
C. Help Authoring & Documentation CMS
Used for publishing ITSM guides, troubleshooting docs, and FAQs.
✅ Best for: Creating ITSM documentation with multiple output formats (PDF, HTML, Help Files).
MadCap Flare – Topic-based authoring, version control, multi-channel publishing.
Adobe RoboHelp – Best for ITSM knowledge bases and help centers.
Adobe FrameMaker – Ideal for large PDF-based ITSM documents.
Paligo – Cloud-based structured authoring for ITSM documentation.
D. Web-Based CMS & Wikis for ITSM Docs
Used for managing ITSM knowledge bases, wikis, and internal documentation.
✅ Best for: IT teams needing a lightweight, searchable documentation repository.
Confluence (Atlassian) – Works with Jira Service Management for ITSM KB.
Wiki.js – Open-source wiki with version control.
Notion / Guru – Lightweight IT documentation for ITSM teams.
SharePoint – Frequently used for storing ITSM process documents.
2. Choosing the Right ITSM Documentation CMS
| CMS Type | Best For | Examples |
| CCMS | Structured DITA-based ITSM docs | IXIASOFT, Heretto, Vasont |
| ITSM KMS | Knowledge bases in ITSM platforms | ServiceNow KM, BMC Helix, Confluence |
| Help Authoring CMS | User guides, SOPs, multi-output docs | MadCap Flare, FrameMaker, RoboHelp |
| Wiki-Based CMS | Internal ITSM documentation | Confluence, Wiki.js, SharePoint |
———————————————————————————————————————————–
Q4. ITSM documentation Workflow you followed?
ITSM Documentation Workflow
A structured ITSM documentation workflow ensures that ITSM process documents, SOPs, runbooks, and knowledge base (KB) articles are created, reviewed, published, and maintained effectively. The workflow should align with ITIL best practices, Knowledge-Centered Service (KCS) principles, and organizational compliance requirements.
1. ITSM Documentation Workflow Stages
A. Planning & Requirements Gathering
📌 Goal: Identify what ITSM documentation needs to be created or updated.
📌 Key Inputs:
ITIL processes (e.g., Incident, Problem, Change, Service Request).
ITSM tool configurations (ServiceNow, BMC Helix, Jira Service Management).
Compliance requirements (ISO 20000, ITIL 4, SOC 2).
🔹 Activities:
✅ Identify documentation needs for ITSM workflows (e.g., KB articles, runbooks).
✅ Gather inputs from SMEs, IT teams, and service desk agents.
✅ Define documentation format (DITA, Markdown, HTML, PDF, etc.).
✅ Plan version control and content governance (e.g., Git, CCMS).
B. Content Creation & Authoring
📌 Goal: Write ITSM documentation with a structured, reusable approach.
📌 Key Inputs:
Technical details from ITSM experts.
Existing KB articles, SOPs, process guides.
🔹 Activities:
✅ Write topic-based, reusable documentation (DITA XML, Markdown, or HTML).
✅ Use ITSM templates for consistency (incident resolution guides, change management SOPs).
✅ Create/update service catalogs and SLAs.
✅ Apply structured authoring for multi-channel publishing.
🛠 Tools:
CCMS: IXIASOFT, Heretto, Vasont (for structured ITSM docs).
Help Authoring Tools: MadCap Flare, FrameMaker, Oxygen XML.
ITSM KB Tools: ServiceNow Knowledge Management, Confluence, SharePoint.
C. Review & Approval Workflow
📌 Goal: Ensure documentation accuracy, compliance, and clarity.
📌 Key Inputs:
Peer reviews, SME validation.
ITIL governance and compliance policies.
🔹 Activities:
✅ Perform peer and SME reviews (technical accuracy, readability).
✅ Validate against ITIL guidelines and security policies.
✅ Track changes with version control (Git, CCMS).
✅ Implement approval workflows (e.g., ITSM knowledge managers, compliance officers).
🛠 Tools:
Approval Workflows: ServiceNow KB Approval, Confluence Workflows.
Version Control: Git (docs-as-code), CCMS (structured docs).
Review Tools: Oxygen XML Editor, Adobe FrameMaker, MadCap Flare.
D. Publishing & Distribution
📌 Goal: Make documentation accessible to IT teams, service desk agents, and end-users.
📌 Key Inputs:
Approved documentation.
ITSM platform integration requirements.
🔹 Activities:
✅ Publish to multiple formats (Web, PDF, HTML, ITSM KB).
✅ Integrate documentation with ITSM tools (ServiceNow, Jira Service Management, BMC Helix).
✅ Automate publishing workflows using CI/CD pipelines (for docs-as-code).
🛠 Tools:
Multi-Format Publishing: DITA-OT, MadCap Flare, Oxygen XML, FrameMaker.
ITSM Integrations: ServiceNow KB API, Jira Service Management KB.
Automation: GitHub Actions, Jenkins, DITA-OT for automated builds.
E. Maintenance & Continuous Improvement
📌 Goal: To keep ITSM documentation up-to-date and relevant.
📌 Key Inputs:
Feedback from users (service desk, IT teams).
Incident trends and change management logs.
🔹 Activities:
✅ Track documentation usage with analytics.
✅ Update outdated or incorrect documentation.
✅ Use Knowledge-Centered Service (KCS) principles to improve ITSM KB articles.
✅ Retire old versions while maintaining an archive.
🛠 Tools:
Feedback Collection: ServiceNow Knowledge Feedback, Confluence Comments.
Usage Analytics: Google Analytics (for web-based docs), ITSM KB Reports.
Version Archiving: Git (for docs-as-code), CCMS (for DITA docs).
2. ITSM Documentation Workflow Example (Using ServiceNow)
Here’s an example of an ITSM KB article workflow in ServiceNow:
1️⃣ Service Desk identifies a recurring issue → Requests a KB article.
2️⃣ Technical Writer creates draft KB article using ServiceNow KB module.
3️⃣ SME reviews & approves via workflow.
4️⃣ KB article is published and linked to incidents in ServiceNow.
5️⃣ Users provide feedback on article effectiveness.
6️⃣ Article is updated/revised based on feedback and incident resolution updates.
3. Best Practices for ITSM Documentation Workflows
✔ Use structured authoring (DITA, Markdown) for consistency.
✔ Automate version control (Git, CCMS, ServiceNow KB).
✔ Integrate with ITSM tools (ServiceNow, Jira, BMC Helix).
✔ Apply ITIL & KCS principles for knowledge management.
✔ Review & update documentation regularly based on user feedback.
————————————————————————————————————————————-
Q5. Optimising ITSM documentation for a specific tool: JIRA (?)
ITSM Documentation Workflow in Jira Service Management (JSM)
Jira Service Management (JSM) provides a structured approach to ITSM documentation by integrating with Confluence for knowledge management, workflows for approvals, and automation for maintaining documentation quality. Below is a detailed ITSM documentation workflow using Jira and Confluence.
1. ITSM Documentation Workflow in Jira Service Management
A. Request & Documentation Initiation
📌 Goal: Identify documentation needs based on ITSM processes (Incidents, Problems, Changes, Service Requests).
📌 Key Inputs:
IT support tickets, service desk requests.
Change management records.
Incident resolution documentation gaps.
🔹 Activities:
✅ IT agents or SMEs create a Documentation Request in Jira (using a custom issue type like “KB Article Request”).
✅ The request is linked to relevant Jira issues (Incidents, Problems, Changes).
✅ A Confluence draft article is auto-created using Jira automation or a template.
🛠 Tools:
Jira Service Management – For tracking documentation requests.
Jira Workflows – Custom workflows for documentation approvals.
Jira Automation – Auto-generate Confluence pages from Jira issues.
B. Content Creation & Authoring (Confluence)
📌 Goal: Create well-structured ITSM documentation linked to Jira issues.
📌 Key Inputs:
Technical details from SMEs, IT teams.
Past resolved incidents or change logs.
🔹 Activities:
✅ Use Confluence templates for knowledge articles, SOPs, FAQs.
✅ Structure content with labels and categories (e.g., Incident-Resolution, Change-Process).
✅ Link Jira issues to Confluence pages for traceability.
🛠 Tools:
Confluence – Main ITSM documentation repository.
Jira-Confluence Integration – Automatically sync ITSM issues with documentation.
Macros & Templates – Standardized ITSM documentation formats.
C. Review & Approval Workflow
📌 Goal: Ensure accuracy, compliance, and alignment with ITIL best practices.
📌 Key Inputs:
SME review, ITIL compliance checks.
Internal review feedback.
🔹 Activities:
✅ Assign documentation reviews using Jira Workflows & Approvals.
✅ Use Jira status transitions (Draft → In Review → Approved → Published).
✅ Collaborate with IT teams using Confluence comments & inline feedback.
🛠 Tools:
Jira Workflows & Approvals – For review & sign-off.
Confluence Page Reviews – For SME feedback.
Atlassian Access – Ensures role-based access control.
D. Publishing & Knowledge Management
📌 Goal: Make documentation accessible in JSM for IT teams and end-users.
📌 Key Inputs:
Approved KB articles and ITSM documentation.
User feedback from service desk tickets.
🔹 Activities:
✅ Publish KB articles in Confluence Knowledge Base.
✅ Link published KBs to Jira Service Management customer portal for self-service.
✅ Use automation to suggest KB articles when users create new tickets.
🛠 Tools:
Confluence Knowledge Base – Stores ITSM documentation.
Jira Service Portal – Displays relevant KB articles to users.
Atlassian Smart Links – Auto-suggests KBs in Jira tickets.
E. Maintenance & Continuous Improvement
📌 Goal: Keep ITSM documentation up to date and relevant.
📌 Key Inputs:
User feedback & KB usage analytics.
ITSM process changes.
🔹 Activities:
✅ Monitor KB article views, feedback, and resolution rates in Confluence Analytics.
✅ Set review reminders in Jira to update articles periodically.
✅ Use Jira Automation to flag outdated articles for revision.
🛠 Tools:
Confluence Analytics – Tracks KB performance.
Jira Automation Rules – Reminders for document updates.
Jira Reports – Monitor documentation effectiveness.
2. ITSM Documentation Workflow Example (Using Jira + Confluence)
| Step | Action | Jira/Confluence Tools Used |
| 1. Request Documentation | IT agents submit KB article requests based on incidents/problems. | Jira Service Management (Custom Issue Type: KB Request) |
| 2. Draft Creation | Technical Writer/SME drafts content in Confluence. | Confluence Templates & Labels |
| 3. Review & Approval | SME & ITIL managers review documentation. | Jira Workflows & Approvals, Confluence Comments |
| 4. Publish KB Article | Approved content is published in Confluence & linked to Jira Portal. | Confluence KB, Jira Smart Links |
| 5. Maintenance & Updates | Auto-reminders for updates, analytics review. | Jira Automation, Confluence Analytics |
3. Best Practices for ITSM Documentation in Jira
✔ Use Jira-Confluence integration for a seamless workflow.
✔ Automate KB article creation from resolved issues.
✔ Standardize ITSM templates in Confluence.
✔ Set expiration/reminder rules for updating documentation.
✔ Monitor KB usage and improve articles based on analytics.
————————————————————————————————————————————–
Q6. Which SDLC methodology have you followed for your ITSM documentation workflow?
SDLC Methodologies for ITSM Documentation
Software Development Life Cycle (SDLC) methodologies help structure and manage ITSM documentation development just like software projects. Choosing the right SDLC model depends on the ITSM documentation requirements, update frequency, and stakeholder collaboration needs.
1. SDLC Methodologies and Their Fit for ITSM Documentation
| SDLC Model | Best For ITSM Documentation | Key Characteristics |
| Waterfall | Large-scale ITSM documentation projects (e.g., Service Catalog, ITIL Process Manuals) | Sequential, structured, well-documented phases |
| Agile (Scrum, Kanban) | Continuous ITSM KB updates, troubleshooting guides | Iterative, frequent updates, SME collaboration |
| DevOps/CI-CD | Automated ITSM documentation updates (Docs-as-Code) | Automation, version control, integration with ITSM tools |
| V-Model | Compliance-heavy ITSM documentation (e.g., SOC 2, ISO 20000 docs) | Validation at each phase, test-driven |
| Spiral | Complex ITSM documentation with evolving requirements | Risk-driven, iterative refinements |
2. Applying SDLC to ITSM Documentation
A. Waterfall Model for ITSM Documentation
📌 Best for: Large ITSM documentation projects like ITIL process manuals, service catalogs, SOPs.
📌 Phases:
1️⃣ Requirement Gathering – Identify ITSM documentation scope.
2️⃣ Planning – Define templates, tools (e.g., CCMS, Confluence, ServiceNow KB).
3️⃣ Content Development – Structured authoring in XML/Markdown.
4️⃣ Review & Approval – SME and compliance validation.
5️⃣ Publishing – Multi-channel publishing (PDF, Web, ITSM tools).
6️⃣ Maintenance – Updates based on process changes.
🔹 Drawback: Slow and rigid, not ideal for frequent KB updates.
B. Agile (Scrum/Kanban) for ITSM Documentation
📌 Best for: Knowledge base (KB) articles, troubleshooting docs, ITSM tool user guides.
📌 Phases:
1️⃣ Backlog Creation – Jira tickets for new/updated documentation.
2️⃣ Sprint Planning – Define docs to be written in each sprint (e.g., 2 weeks).
3️⃣ Content Development – Writers collaborate with SMEs (Confluence, Git).
4️⃣ Review & Feedback – Iterative peer and SME reviews.
5️⃣ Publishing – Continuous updates to ITSM KB.
🔹 Example Workflow in Jira:
Jira issue for KB update → Assigned to writer → Sprint work → SME review → Publish in Confluence.
🔹 Best Tools:
✅ Jira + Confluence (Kanban for backlog, Scrum for sprints).
✅ MadCap Flare + Git (Docs-as-Code approach).
✅ ServiceNow KB workflows (Agile KB updates).
C. DevOps & CI/CD for ITSM Documentation
📌 Best for: Automated ITSM documentation updates in ITSM tools (Docs-as-Code, API Docs).
📌 Phases:
1️⃣ Git-based Content Management – Store docs in Git repositories.
2️⃣ Continuous Integration – Auto-build docs (DITA-OT, MkDocs, Sphinx).
3️⃣ Automated Reviews – CI pipelines (Jenkins, GitHub Actions) for approval.
4️⃣ Continuous Deployment – Auto-publish ITSM documentation updates.
5️⃣ Monitoring & Feedback – Logs & analytics for improvements.
🔹 Best Tools:
✅ GitHub/GitLab CI – Docs versioning & automation.
✅ DITA-OT + Oxygen XML – For structured ITSM docs.
✅ Jenkins + ServiceNow API – Auto-publish docs to ITSM KB.
🔹 Example Workflow:
Incident Management SOP stored in Git → PR for updates → Jenkins builds → Auto-publish to ServiceNow KB.
D. V-Model for Compliance-Driven ITSM Documentation
📌 Best for: Compliance-heavy ITSM documentation (ISO 20000, SOC 2, ITIL audits).
📌 Phases:
1️⃣ Requirement Definition – Document security, compliance needs.
2️⃣ Content Development – Write structured SOPs, security policies.
3️⃣ Validation & Testing – Compliance review, risk assessments.
4️⃣ Approval & Release – Official sign-off before publication.
5️⃣ Maintenance & Audits – Update based on compliance changes.
🔹 Best Tools:
✅ Vasont, IXIASOFT CCMS – Strict version control for compliance docs.
✅ ServiceNow Policy & Compliance – Tracks audit logs for ITSM docs.
✅ SharePoint, Confluence – Stores compliance documentation.
E. Spiral Model for Evolving ITSM Documentation
📌 Best for: ITSM documentation with frequent process changes (e.g., DevOps/ITIL integration, hybrid ITSM frameworks).
📌 Phases:
1️⃣ Planning – Define doc structure, iteration scope.
2️⃣ Risk Analysis – Identify knowledge gaps.
3️⃣ Prototype & Review – Create quick documentation drafts.
4️⃣ Iteration Updates – Refine based on feedback.
🔹 Best Tools:
✅ Paligo CCMS – Iterative documentation refinements.
✅ Jira + Confluence – Documentation tracking with feedback loops.
✅ Oxygen XML + Git – Version-controlled iterative updates.
3. Choosing the Right SDLC Model for ITSM Documentation
| Use Case | Recommended SDLC Model | Best Tools |
| Service Catalogs, ITIL Process Docs | Waterfall | MadCap Flare, FrameMaker, CCMS |
| ITSM KB Updates, FAQs, SOPs | Agile (Scrum/Kanban) | Jira, Confluence, ServiceNow KB |
| Docs-as-Code, Automated ITSM Docs | DevOps/CI-CD | Git, Jenkins, MkDocs, DITA-OT |
| Compliance & Security Docs | V-Model | SharePoint, ServiceNow Compliance |
| Dynamic ITSM Frameworks (ITIL + DevOps) | Spiral | Paligo, Jira, Confluence |
4. Best Practices for ITSM Documentation SDLC
✔ Align documentation SDLC with ITSM processes (ITIL, KCS, DevOps).
✔ Use Agile for dynamic KB updates, Waterfall for structured ITIL documentation.
✔ Automate CI/CD for Docs-as-Code in ITSM platforms.
✔ Implement version control (Git, CCMS) for compliance-heavy docs.
✔ Integrate ITSM tools (ServiceNow, Jira) with documentation workflows.
————————————————————————————————————————————
Q6.1 How do you perform Jira workflow setup for Agile documentation?
Jira Workflow Setup for Agile Documentation
Jira provides an efficient way to manage Agile documentation workflows, especially for ITSM documentation, using Scrum or Kanban boards. Below is a step-by-step guide to set up a Jira workflow for Agile documentation.
1. Setting Up an Agile Documentation Workflow in Jira
A. Create a Jira Project for Documentation
📌 Steps:
✅ Go to Jira Software → Click Create Project.
✅ Choose Scrum or Kanban based on your workflow:
Scrum (Sprint-based) → Best for structured ITSM documentation updates.
Kanban (Continuous flow) → Best for ongoing ITSM KB maintenance.
✅ Name the project (e.g., ITSM Documentation).
B. Define Issue Types for Documentation Tasks
📌 Steps:
✅ Go to Project Settings → Issue Types.
✅ Add custom issue types for documentation:
KB Article – New or updated knowledge base articles.
User Guide – User manuals, SOPs, ITIL process docs.
Troubleshooting Doc – Technical issue resolution guides.
Compliance Doc – Policies, audit documentation.
✅ Define custom fields:
Documentation Type (Dropdown: KB, SOP, Policy, FAQ).
ITSM Process Link (Dropdown: Incident, Change, Problem).
SME Reviewer (User picker).
C. Create a Custom Workflow for Documentation
📌 Steps:
✅ Go to Jira Administration → Issues → Workflows.
✅ Click Create New Workflow → Name it (e.g., “Agile Documentation Workflow”).
Recommended Jira Workflow Stages:
1️⃣ Backlog – New documentation requests.
2️⃣ In Progress – Active writing and content creation.
3️⃣ SME Review – Subject Matter Expert (SME) or ITIL review.
4️⃣ QA Review – Technical writer/editor reviews content.
5️⃣ Ready for Publishing – Approved, awaiting deployment.
6️⃣ Published – Live in Confluence/ServiceNow KB.
7️⃣ Needs Update – Marked for future revisions.
✅ Set Up Workflow Transitions:
Backlog → In Progress (Assigned to writer).
In Progress → SME Review (Reviewer approval needed).
SME Review → QA Review (Tech writer verification).
QA Review → Ready for Publishing (Final check).
Ready for Publishing → Published (Deploy to KB).
D. Automate Workflow Actions with Jira Automation
📌 Example Automations:
✅ Auto-create a Confluence draft from Jira Issues:
Trigger: New KB Article request in Jira.
Action: Auto-create a Confluence page using a predefined template.
✅ Auto-assign review tasks:
Trigger: Status changes to SME Review.
Action: Assign the ticket to an SME.
✅ Notify ITSM Teams on Documentation Updates:
Trigger: Status changes to Published.
Action: Post an update in a Slack or MS Teams channel.
✅ Track outdated KB articles:
Trigger: An article is older than 6 months.
Action: Move it to Needs Update and notify the team.
E. Create an Agile Board for Documentation Tracking
📌 Steps:
✅ Go to Jira Software → Boards → Create Board.
✅ Select Scrum or Kanban, and link it to the Documentation Project.
✅ Configure columns based on workflow stages (Backlog → Published).
✅ Add Swimlanes for categories (e.g., ServiceNow KB, ITIL Docs, Troubleshooting Guides).
2. Best Practices for Agile Documentation in Jira
✔ Use Jira + Confluence integration to sync documentation tasks and articles.
✔ Set SLA reminders for KB updates using automation.
✔ Use Kanban for ongoing updates, Scrum for structured releases.
✔ Implement Labels & Components for easy searchability.
✔ Track progress with Jira Reports (e.g., KB updates per month).
3. Example Jira Workflow for ITSM Documentation
| Step | Jira Issue Status | Action | Tools Used |
| 1. Request | Backlog | Create a KB Article request in Jira | Jira Issue, Forms |
| 2. Writing | In Progress | Writer drafts content | Confluence, Jira |
| 3. SME Review | SME Review | SME validates content | Jira Approval Workflow |
| 4. Editorial Review | QA Review | Editor checks consistency | Confluence Comments |
| 5. Approval | Ready for Publishing | Final sign-off | Jira Approvals |
| 6. Publishing | Published | Auto-publish to Confluence/ITSM KB | ServiceNow KB, Confluence API |
| 7. Maintenance | Needs Update | Set reminders for review | Jira Automation |
————————————————————————————————————————————-
Q7. What is your video creation workflow for ITSM documentation (?)
Video Creation in ITSM Documentation
Creating videos for ITSM documentation enhances knowledge transfer, improves user adoption, and simplifies complex ITIL processes. Below is a complete guide to video creation in ITSM documentation, including best practices, tools, and workflows.
1. Types of ITSM Documentation Videos
| Video Type | Use Case | Examples |
| How-to Tutorials | Demonstrate ITSM tool usage | “How to create an incident in ServiceNow” |
| Process Walkthroughs | Explain ITIL workflows | “Change Management process in Jira Service Management” |
| Troubleshooting Guides | Solve common IT issues | “Fixing a failed service request” |
| Training Videos | ITIL certification, onboarding | “ITIL 4 Incident Management Overview” |
| Release Notes & Updates | ITSM tool feature updates | “New ServiceNow ITSM Features in 2025” |
2. Video Creation Workflow in ITSM Documentation
A. Define Video Requirements
📌 Steps:
✅ Identify audience (IT teams, service desk agents, end-users).
✅ Determine video type (tutorial, process demo, troubleshooting).
✅ Choose the ITSM tool to document (ServiceNow, BMC Helix, Jira SM).
📌 Example:
Goal: Create a how-to video for logging incidents in ServiceNow.
B. Script & Storyboard Creation
📌 Steps:
✅ Write a video script – Clear steps with voiceover/dialogue.
✅ Create a storyboard – Plan visuals/screens.
✅ Get SME approval for accuracy.
📌 Example:
🎬 Scene 1: Intro – “Welcome to this tutorial on logging an incident in ServiceNow.”
🎬 Scene 2: Screen capture – Navigate to “Create Incident” page.
🎬 Scene 3: Voiceover – “Enter the issue details and click Submit.”
🎬 Scene 4: Outro – “Check your email for incident updates!”
📌 Tools:
✅ Google Docs, Confluence – Script writing.
✅ Storyboarding Tools – Canva, Miro.
C. Recording & Screen Capture
📌 Steps:
✅ Use a screen recording tool (Camtasia, OBS, Loom).
✅ Record narration/voiceover (Audacity, Camtasia).
✅ Add highlighting, callouts, and cursor effects.
📌 Best Tools for ITSM Video Creation:
🎥 Camtasia – Best for detailed ITSM process tutorials.
🎥 OBS Studio – Free, great for live recording.
🎥 Loom – Quick video creation for IT support teams.
🎥 Snagit – Easy screen capture with annotations.
🎙️ Audacity – Noise-free voiceover recording.
D. Editing & Enhancements
📌 Steps:
✅ Trim unnecessary parts, add transitions.
✅ Insert annotations (highlight buttons, text overlays).
✅ Add background music or subtitles.
📌 Best Editing Tools:
🎬 Camtasia – Built-in effects & annotations.
🎬 Adobe Premiere Pro – Advanced ITSM video editing.
🎬 CapCut – Simple, free video editor.
E. Publishing & Distribution
📌 Steps:
✅ Export in MP4, WebM for compatibility.
✅ Upload to ITSM portals, knowledge base, or LMS.
✅ Integrate with ServiceNow, Confluence, SharePoint.
📌 Best Hosting Platforms:
📂 Confluence – Embed videos in ITSM documentation.
📂 ServiceNow Knowledge Base – Attach videos to KB articles.
📂 Microsoft Stream – Internal ITSM training videos.
📂 YouTube (Private) – Share restricted ITSM process videos.
3. Best Practices for ITSM Video Documentation
✔ Keep it short – 2-5 minutes per video for better engagement.
✔ Use real ITSM tool UI – Demonstrate actions directly in ServiceNow, Jira, etc.
✔ Add captions/subtitles – Improves accessibility.
✔ Follow ITIL terminology – Use standard ITSM terms (Incident, Change, Request).
✔ Embed in ITSM docs – Link videos inside Confluence, ServiceNow KB, Jira SM articles.
4. Example ITSM Documentation Video Workflow in Jira
| Step | Jira Issue Status | Action | Tools Used |
| 1. Video Request | Backlog | Request submitted | Jira Service Management |
| 2. Script Writing | In Progress | SME approval | Google Docs, Confluence |
| 3. Recording | In Progress | Screen capture, voiceover | Camtasia, OBS, Loom |
| 4. Editing | Review | Annotations, subtitles | Premiere Pro, Camtasia |
| 5. SME Approval | Ready for Publishing | Final review | Jira Approvals |
| 6. Publishing | Published | Upload to ITSM KB | ServiceNow, Confluence |
| 7. Maintenance | Needs Update | Review every 6 months | Jira Automation |
Do you need templates for ITSM video scripts?
ITSM Video Script Templates
Here are ITSM video script templates for different types of documentation videos. You can customize them based on your ITSM tool (ServiceNow, Jira Service Management, BMC Helix, etc.).
D. Automate Workflow Actions with Jira Automation
📌 Example Automations:
✅ Auto-create a Confluence draft from Jira Issues:
Trigger: New KB Article request in Jira.
Action: Auto-create a Confluence page using a predefined template.
✅ Auto-assign review tasks:
Trigger: Status changes to SME Review.
Action: Assign the ticket to an SME.
✅ Notify ITSM Teams on Documentation Updates:
Trigger: Status changes to Published.
Action: Post an update in a Slack or MS Teams channel.
✅ Track outdated KB articles:
Trigger: An article is older than 6 months.
Action: Move it to Needs Update and notify the team.
E. Create an Agile Board for Documentation Tracking
📌 Steps:
✅ Go to Jira Software → Boards → Create Board.
✅ Select Scrum or Kanban, and link it to the Documentation Project.
✅ Configure columns based on workflow stages (Backlog → Published).
✅ Add Swimlanes for categories (e.g., ServiceNow KB, ITIL Docs, Troubleshooting Guides).
2. Best Practices for Agile Documentation in Jira
✔ Use Jira + Confluence integration to sync documentation tasks and articles.
✔ Set SLA reminders for KB updates using automation.
✔ Use Kanban for ongoing updates, Scrum for structured releases.
✔ Implement Labels & Components for easy searchability.
✔ Track progress with Jira Reports (e.g., KB updates per month).
3. Example Jira Workflow for ITSM Documentation
| Step | Jira Issue Status | Action | Tools Used |
| 1. Request | Backlog | Create a KB Article request in Jira | Jira Issue, Forms |
| 2. Writing | In Progress | Writer drafts content | Confluence, Jira |
| 3. SME Review | SME Review | SME validates content | Jira Approval Workflow |
| 4. Editorial Review | QA Review | Editor checks consistency | Confluence Comments |
| 5. Approval | Ready for Publishing | Final sign-off | Jira Approvals |
| 6. Publishing | Published | Auto-publish to Confluence/ITSM KB | ServiceNow KB, Confluence API |
| 7. Maintenance | Needs Update | Set reminders for review | Jira Automation |
————————————————————————————————————————————-
Q7. What is your video creation workflow for ITSM documentation (?)
Video Creation in ITSM Documentation
Creating videos for ITSM documentation enhances knowledge transfer, improves user adoption, and simplifies complex ITIL processes. Below is a complete guide to video creation in ITSM documentation, including best practices, tools, and workflows.
1. Types of ITSM Documentation Videos
| Video Type | Use Case | Examples |
| How-to Tutorials | Demonstrate ITSM tool usage | How to create an incident in ServiceNow |
| Process Walkthroughs | Explain ITIL workflows | Change Management process in Jira Service Management |
| Troubleshooting Guides | Solve common IT issues | Fixing a failed service request |
| Training Videos | ITIL certification, onboarding | ITIL 4 Incident Management Overview |
| Release Notes & Updates | ITSM tool feature updates | New ServiceNow ITSM Features in 2025 |
2. Video Creation Workflow in ITSM Documentation
A. Define Video Requirements
📌 Steps:
✅ Identify audience (IT teams, service desk agents, end-users).
✅ Determine video type (tutorial, process demo, troubleshooting).
✅ Choose the ITSM tool to document (ServiceNow, BMC Helix, Jira SM).
📌 Example:
Goal: Create a how-to video for logging incidents in ServiceNow.
B. Script & Storyboard Creation
📌 Steps:
✅ Write a video script – Clear steps with voiceover/dialogue.
✅ Create a storyboard – Plan visuals/screens.
✅ Get SME approval for accuracy.
📌 Example:
🎬 Scene 1: Intro – “Welcome to this tutorial on logging an incident in ServiceNow.”
🎬 Scene 2: Screen capture – Navigate to “Create Incident” page.
🎬 Scene 3: Voiceover – “Enter the issue details and click Submit.”
🎬 Scene 4: Outro – “Check your email for incident updates!”
📌 Tools:
✅ Google Docs, Confluence – Script writing.
✅ Storyboarding Tools – Canva, Miro.
C. Recording & Screen Capture
📌 Steps:
✅ Use a screen recording tool (Camtasia, OBS, Loom).
✅ Record narration/voiceover (Audacity, Camtasia).
✅ Add highlighting, callouts, and cursor effects.
📌 Best Tools for ITSM Video Creation:
🎥 Camtasia – Best for detailed ITSM process tutorials.
🎥 OBS Studio – Free, great for live recording.
🎥 Loom – Quick video creation for IT support teams.
🎥 Snagit – Easy screen capture with annotations.
🎙️ Audacity – Noise-free voiceover recording.
D. Editing & Enhancements
📌 Steps:
✅ Trim unnecessary parts, add transitions.
✅ Insert annotations (highlight buttons, text overlays).
✅ Add background music or subtitles.
📌 Best Editing Tools:
🎬 Camtasia – Built-in effects & annotations.
🎬 Adobe Premiere Pro – Advanced ITSM video editing.
🎬 CapCut – Simple, free video editor.
E. Publishing & Distribution
📌 Steps:
✅ Export in MP4, WebM for compatibility.
✅ Upload to ITSM portals, knowledge base, or LMS.
✅ Integrate with ServiceNow, Confluence, SharePoint.
📌 Best Hosting Platforms:
📂 Confluence – Embed videos in ITSM documentation.
📂 ServiceNow Knowledge Base – Attach videos to KB articles.
📂 Microsoft Stream – Internal ITSM training videos.
📂 YouTube (Private) – Share restricted ITSM process videos.
3. Best Practices for ITSM Video Documentation
✔ Keep it short – 2-5 minutes per video for better engagement.
✔ Use real ITSM tool UI – Demonstrate actions directly in ServiceNow, Jira, etc.
✔ Add captions/subtitles – Improves accessibility.
✔ Follow ITIL terminology – Use standard ITSM terms (Incident, Change, Request).
✔ Embed in ITSM docs – Link videos inside Confluence, ServiceNow KB, Jira SM articles.
4. Example ITSM Documentation Video Workflow in Jira
| Step | Jira Issue Status | Action | Tools Used |
| 1. Video Request | Backlog | Request submitted | Jira Service Management |
| 2. Script Writing | In Progress | SME approval | Google Docs, Confluence |
| 3. Recording | In Progress | Screen capture, voiceover | Camtasia, OBS, Loom |
| 4. Editing | Review | Annotations, subtitles | Premiere Pro, Camtasia |
| 5. SME Approval | Ready for Publishing | Final review | Jira Approvals |
| 6. Publishing | Published | Upload to ITSM KB | ServiceNow, Confluence |
| 7. Maintenance | Needs Update | Review every 6 months | Jira Automation |
Do you need templates for ITSM video scripts?
ITSM Video Script Templates
Here are ITSM video script templates for different types of documentation videos. You can customize them based on your ITSM tool (ServiceNow, Jira Service Management, BMC Helix, etc.).
2. CRM (Customer Relationship Management)
📌 Definition
CRM platforms help organizations manage customer interactions, support tickets, and sales pipelines across multiple channels (email, chat, phone, social media).
🏢 Use Cases in ITSM
✅ Service Desk Integration – Connects ITSM tools like ServiceNow or Jira SM with CRM for tracking customer issues.
✅ Incident & Problem Management – Links customer complaints to IT incidents & root cause analysis.
✅ Automated Workflows – Automates responses for ticket escalation, approvals, and follow-ups.
🏆 Examples of CRM Platforms
📊 Salesforce CRM – Integrates with ServiceNow for ITSM & customer service.
📊 Microsoft Dynamics 365 – AI-driven CRM for support, sales, and marketing.
📊 HubSpot CRM – Free CRM with basic ITSM integrations.
📊 Zoho CRM – AI-powered customer service and automation.
📊 Zendesk – Common in help desk & ITSM environments.
3. AI Platforms
📌 Definition
AI platforms provide machine learning, natural language processing (NLP), and automation to improve decision-making, customer service, and IT operations.
🤖 Use Cases in ITSM & CRM
✅ AI Chatbots & Virtual Agents – Automates IT support (e.g., ServiceNow Virtual Agent).
✅ Predictive Analytics – AI predicts incident trends, ticket volumes, and issue resolutions.
✅ Automated ITSM Workflows – AI-driven workflows for incident classification, change approvals, and root cause analysis.
✅ Sentiment Analysis in CRM – Detects customer emotions from emails & chat messages.
🚀 Examples of AI Platforms
| AI Tool | Key Features / Use Cases |
| ServiceNow AI Ops | Predicts and prevents IT issues. |
| Google Vertex AI | Cloud-based AI for automation. |
| IBM Watson AI | AI-powered IT support and chatbot automation. |
| Microsoft Azure AI | Integrates with Dynamics 365 & ITSM tools. |
| OpenAI GPT (like ChatGPT!) | AI for IT documentation, automation, and chatbots. |
🚀 How They Work Together in ITSM
| Technology | Example Use Case | Example Tools |
| Enterprise Search | IT agents quickly search KB for incident resolution | ServiceNow AI Search, Elasticsearch |
| CRM | Customer complaint links to an IT ticket | Salesforce, Microsoft Dynamics |
| AI Platform | AI predicts incident spikes & automates responses | ServiceNow AI Ops, IBM Watson |
————————————————————————————————————————————-
Q 8.1 Would you like a comparison of tools or help with ITSM integrations?
Comparison of Enterprise Search, CRM, and AI Platforms for ITSM Integration
Below is a detailed comparison table of tools from each category—Enterprise Search, CRM, and AI Platforms—and how they integrate with ITSM solutions such as ServiceNow, Jira Service Management, and BMC Helix.
| Category | Tool | Use Case in ITSM | Integration with ITSM | Features | Example ITSM Integration |
| Enterprise Search | ServiceNow AI Search | Find knowledge base articles, incidents, and change records | ServiceNow: Built-in search functionality for ITSM records | Advanced AI-based search, contextual suggestions, NLP capabilities | Integrated directly into ServiceNow to search KBs, incidents, and change requests. Improves resolution times. |
| Elasticsearch | Search across multiple systems (knowledge bases, incident logs) | Works with various ITSM tools for full-text search capabilities | Open-source, scalable, distributed search system, integrates with web and app data | Used in Jira Service Management for ticket and KB search; can be customized for service desk needs. | |
| Google Cloud Search | Search within Google Workspace documents and external systems | Integrates with ServiceNow and Jira via connectors | AI-powered, integrates with Google Workspace, deep analytics capabilities | Can search across Google Drive, Jira, and Confluence to improve service desk knowledge sharing. | |
| CRM | Salesforce CRM | Manage customer interactions and track IT issues | Integrates with ServiceNow for cross-platform visibility | AI-powered, automation for sales and customer service, customer profiles | ServiceNow integrates with Salesforce to link ITSM incident records to customer service requests and automate workflows. |
| Microsoft Dynamics 365 | Track service requests and customer interactions | Integrates with Jira Service Management for ITSM workflows | AI-driven, sales, marketing, customer service management tools | Jira integrates with Dynamics 365 for tracking customer queries and incidents across both platforms. | |
| Zendesk | Manage customer support tickets and integrate with ITSM tools | Integrates with ServiceNow for seamless ticket resolution | Multi-channel customer support (email, chat, voice), self-service portals | ServiceNow integrates with Zendesk to link customer tickets to IT incidents, improving agent response time. | |
| AI Platform | ServiceNow AI Ops | Predict and automate IT operations based on incident data | Built-in with ServiceNow ITSM for incident and change automation | AI-based anomaly detection, predictive analytics, and automated remediation | Uses AI Ops to predict incident trends and suggest solutions, improving service uptime and incident management. |
| Google Vertex AI | Create custom AI models to automate tasks like ticket routing | Integrates with ITSM platforms like Jira and ServiceNow | Customizable AI models for ITSM processes, NLP, machine learning capabilities | Integrates with ServiceNow and Jira to create custom models for ticket triage and incident prioritization. | |
| IBM Watson AI | Enhance customer service with automated responses | Works with Jira Service Management and ServiceNow | NLP, conversational AI, cognitive automation, chatbots | Jira integrates with Watson AI to automate service desk ticket creation and routing, improving agent efficiency. |
Key Takeaways for ITSM Integrations
- Enterprise Search tools like ServiceNow AI Search and Elasticsearch allow IT agents to search knowledge bases, incident logs, and change records quickly, significantly reducing resolution times and improving productivity.
- CRM platforms such as Salesforce and Zendesk streamline customer interactions, enabling a seamless flow of information between the IT Service Desk and the customer support team. This leads to better incident tracking, resolution, and proactive service.
- AI Platforms like ServiceNow AI Ops and IBM Watson AI leverage machine learning and predictive analytics to help IT teams anticipate incidents, automate workflows, and optimize service delivery. AI can also power chatbots to reduce manual intervention and improve efficiency.
Best Tools for Integration with ITSM Solutions
- ServiceNow AI Search: Best for businesses already using ServiceNow, it’s highly integrated for fast and accurate ITSM search functionalities.
- Salesforce CRM: Best for companies that need a comprehensive view of customer interactions alongside IT support tickets.
- ServiceNow AI Ops: Best for predictive analytics and automating incident resolution processes within the ServiceNow ecosystem.
- Google Vertex AI: Ideal for companies that want custom AI models tailored to specific ITSM workflows.
Next Steps for Your ITSM Setup?
Interested in exploring custom integrations between Salesforce or Zendesk and your ITSM tools?
Need help configuring AI workflows in ServiceNow or Jira SM? Let me know how I can assist further!
————————————————————————————————————————————-
Q10. What is your experience with help articles in the ITSM documentation workflow?
Help Articles in ITSM Documentation Workflow
Help articles play a crucial role in ITSM documentation workflows, especially when it comes to self-service portals, knowledge management, and incident resolution. Here’s a breakdown of how they fit into the ITSM documentation workflow and best practices for creating and maintaining them.
1. Role of Help Articles in ITSM Documentation Workflow
Help articles in ITSM are typically designed to assist end users, support agents, and IT staff by providing step-by-step guides, solutions to common issues, and best practices for using IT services or troubleshooting problems. They can be integrated into self-service portals or used by agents to resolve incidents and requests more efficiently.
Key Functions:
- Self-service for End Users: Users can search help articles to troubleshoot issues independently.
- Knowledge Sharing for Agents: Service desk agents use help articles to find solutions for recurring incidents.
- Reduce Ticket Volumes: Articles reduce the number of tickets logged by providing users with solutions to common issues.
- Faster Incident Resolution: Well-structured articles help agents solve issues faster by offering documented solutions or troubleshooting steps.
- Improve Service Availability: Users and agents can quickly address common problems, reducing downtime.
2. Creating and Managing Help Articles in ITSM Documentation Workflow
Steps to Integrate Help Articles into the ITSM Workflow
Step 1: Content Creation
Identify Common Issues: Focus on frequently reported incidents, service requests, or problems.
- Use ITIL Practices: Structure articles based on incident management, problem management, and change management best practices.
- Collaborate with IT and Support Teams: Work closely with technical teams to ensure accurate solutions are documented for each issue.
- Follow a Template: Use consistent templates for creating articles to maintain a uniform look and feel. This includes sections such as:
Issue Description
- Symptoms
- Root Cause
- Resolution/Workaround
- Step-by-step Instructions
- Additional Resources or Links
Example Article Template:
| Section | Description |
| Issue Description | Short summary of the problem. |
| Symptoms | List of what users might observe when the issue occurs. |
| Cause/Root Cause | Explanation of what causes the issue. |
| Resolution Steps | Clear, step-by-step instructions to resolve the issue. |
| Additional Resources | Links to further documentation, troubleshooting tools, or contact info. |
Step 2: Article Review & Approval
- Peer Review: Articles should undergo a peer review by both content creators and subject-matter experts (SMEs) to ensure technical accuracy.
- Approval Workflow: Depending on your ITSM tool (like ServiceNow, Jira, BMC Helix), create an approval workflow for articles before they are published.
Step 3: Article Publishing
- Integrate with Self-Service Portals: Publish the articles on your service desk’s self-service portal for end users to access.
- Categorize: Categorize articles based on the issue types (e.g., network issues, software issues, access problems).
- Search Functionality: Ensure articles are easily searchable via keywords, tags, or categories. Tools like ServiceNow Knowledge Management or Jira Service Management support searchable knowledge bases.
Step 4: Article Maintenance & Updates
- Monitor Usage & Feedback: Keep track of how often articles are accessed, and gather feedback from users and agents on their usefulness.
- Continuous Updates: Regularly update articles to reflect any changes in the system, software, or solutions. Incorporate new resolution steps and workarounds as needed.
- Version Control: Maintain version control to track changes and ensure historical articles are preserved for reference.
Step 5: Reporting and Metrics
- Track Help Article Effectiveness: Monitor the number of views, feedback ratings, and whether users resolve issues via articles.
- Assess Article Gaps: Look for recurring incidents that do not have a documented solution and create new articles accordingly.
- Reporting for Knowledge Management: Generate reports on the number of incidents resolved through self-service articles to gauge knowledge base effectiveness.
3. Tools and Best Practices for Help Articles in ITSM Documentation
ITSM Platforms with Knowledge Management
ServiceNow:
- Knowledge Management integrates with the Service Desk and Incident Management modules, allowing agents to access help articles while resolving issues.
- Allows users to rate articles and provide feedback to improve content quality.
Jira Service Management:
- Provides a knowledge base for both end users and agents, easily accessible via the self-service portal.
- Confluence is often used alongside Jira for creating and maintaining knowledge articles.
BMC Helix ITSM:
- Offers a Knowledge Management module where users and agents can find articles related to incidents, problems, and changes.
- The system provides suggestions for articles during the incident logging process to improve ticket resolution times.
Best Practices
- Keep it Simple: Write articles in simple, clear language. Avoid jargon to ensure they are accessible to both technical and non-technical users.
- Visual Aids: Include screenshots, diagrams, or videos in help articles for more complex instructions.
- Use Automation: In platforms like ServiceNow, automate article suggestions based on the incident type or keywords in user requests.
- Align with ITIL Practices: Structure articles around ITIL processes, ensuring alignment with incident management, problem management, and service request fulfilment.
4. Examples of ITSM Help Articles
Example 1: “How to Reset Your Password in ServiceNow”
Issue: User unable to access their ServiceNow account.
Symptoms: User sees “Invalid Credentials” message.
Resolution:
- Navigate to the ServiceNow login page.
- Click “Forgot Password” under the login button.
- Enter your username or email address.
- Example 2: “How to Log a Change Request in Jira Service Management”
- Issue: A user needs to make a change to a network configuration.
- Symptoms: Request for a change not being processed.
Resolution:
- Log in to Jira Service Management.
- Navigate to the “Change Requests” section.
- Click “Create New Request” and fill in the necessary details.
- Submit for review by the Change Manager.
———————————————————————————————————————————
Q10.1 How do you create or organize help articles for your ITSM platform?
Creating and Organizing Help Articles for Your ITSM Platform
Creating and organizing help articles for your ITSM platform is a vital part of streamlining incident resolution, enhancing user experience, and improving the overall service desk efficiency. Below is a step-by-step guide and best practices for creating and organizing help articles effectively in your ITSM platform like ServiceNow, Jira Service Management, or BMC Helix.
1. Structuring the Content of Help Articles
Creating structured and easy-to-follow help articles ensures that users can quickly find solutions to their issues. Here’s how you can approach the structure:
Article Template:
| Section | Details |
| Title | Clear, concise, and describes the issue/solution (e.g., “How to Reset Your Password in ServiceNow”). |
| Overview | A short description of what the article covers (e.g., “This article explains how to reset your ServiceNow password.”). |
| Prerequisites | Any requirements or conditions that must be met before following the steps (e.g., “You must have access to your registered email”). |
| Steps | A detailed list of instructions or actions to resolve the issue (use numbered or bullet points for clarity). |
| Screenshots/Videos | Visual aids like screenshots, GIFs, or videos to make the process clearer. |
| Troubleshooting | Tips for users who might encounter errors or issues during the process. |
| Related Articles | Links to related help articles (e.g., “How to unlock your ServiceNow account”). |
| Feedback Section | Option for users to provide feedback (like “Was this helpful?”). |
Example Article:
- Title: “How to Submit a Change Request in Jira Service Management”
- Overview: This article guides you through submitting a change request in Jira Service Management.
- Prerequisites: Ensure you have the necessary permissions for submitting change requests.
Steps:
- Log in to Jira Service Management.
- Navigate to Change Requests > Create New Request.
- Fill in the required fields such as Change Type, Description, and Risk Level.
- Click Submit for review.
Troubleshooting: If you encounter an error, check if you have the necessary permissions or try again later.
Related Articles:
- How to View Change Request Status
- How to Update an Existing Change Request
- Feedback Section: “Was this article helpful?” Yes / No
2. Organizing Help Articles in ITSM Platforms
Once you’ve created help articles, organizing them within your ITSM platform is key for usability and accessibility. Here’s how you can do it:
Best Practices for Organizing Articles
Categorization:
Organize articles into logical categories based on common issues. For example:
- User Access Issues
- Service Requests
- Incident Management
- Change Requests
- System Troubleshooting
Tagging:
Use tags for easy searching. Tags could be based on:
- Keywords (e.g., “password reset,” “network issue,” “incident resolution”)
- Priority (e.g., “critical,” “high,” “low”)
- Product/Service (e.g., “ServiceNow,” “Microsoft Teams”)
Search Optimization:
- Ensure articles are searchable by keywords and tags so users can easily find relevant content.
- Use a consistent naming convention for titles to make articles easy to find (e.g., “How to [Action] in [Platform]”).
- Organizational Structure Example in ServiceNow
Category: Service Desk
Subcategory: Password Issues
Article 1: “How to Reset Your ServiceNow Password”
Article 2: “How to Unlock Your Account in ServiceNow”
Subcategory: Network Issues
Article 1: “How to Troubleshoot Network Connectivity”
Article 2: “How to Request Network Access”
Organizational Structure Example in Jira Service Management
Knowledge Base
Category: Incident Management
Article 1: “How to Report an Incident in Jira Service Management”
Article 2: “How to Escalate a Critical Incident”
Category: Change Management
Article 1: “How to Submit a Change Request”
Article 2: “How to Approve a Change Request”
3. Best Practices for Maintaining Help Articles
Help articles must be kept up-to-date and continuously improved to ensure they remain relevant and effective.
Regular Reviews
- Schedule periodic reviews to update articles based on changes in systems, processes, or user feedback.
- Keep track of common incidents and new trends to create or update articles addressing emerging issues.
User Feedback
- Enable feedback at the end of each article to help improve the quality of content. You can use simple thumbs up/down, or a more detailed survey on article effectiveness.
- Monitor feedback to identify which articles are helpful and which need revisions.
Version Control
- Maintain version control for each article so you can track changes and ensure that previous versions are preserved.
- If significant changes are made to an article, ensure that users are notified (for example, via notifications in ServiceNow or Jira).
4. Tools for Organizing and Managing Help Articles
Most ITSM tools come with integrated knowledge management systems that allow you to create, organize, and manage help articles.
ServiceNow Knowledge Management
- Provides a central repository for creating and managing help articles.
- Allows integration with incident, problem, and change management, so articles are easily accessible when needed.
- Includes feedback and ratings to continuously improve the quality of content.
Jira Service Management with Confluence
- Confluence is typically used in conjunction with Jira to manage knowledge base articles.
- It allows you to categorize, tag, and search articles efficiently.
- You can link Jira tickets to relevant articles directly from the help desk interface.
BMC Helix ITSM
- Offers a Knowledge Management module for creating, publishing, and organizing help articles.
- Includes features like knowledge workflows and article feedback to continuously improve the content.
5. Automating Article Suggestions
In modern ITSM platforms, you can also automate the process of suggesting relevant help articles to end-users or agents during incident creation or resolution:
- ServiceNow: When a user logs an incident, ServiceNow can suggest relevant help articles based on the incident’s description or keywords.
- Jira Service Management: By linking to Confluence, relevant articles can be automatically displayed in the customer portal or agent interface when submitting tickets.