IssueTracker user guide

Overview

IssueTracker is a comprehensive project management platform with advanced features for issue tracking, compliance management, change management, and real-time collaboration.

Contents

• Quick Start
• Issue Management
• Board Views
• Compliance Management
• Change Management
• Executive Dashboard
• Collaboration Documents
• Plugin Marketplace
• Security & Single Sign-On (SSO)
• Navigation Guide
• Command Palette & Keyboard Shortcuts

Quick Start

Getting Started

1. Access the Platform

   • Navigate to your Instance URL
   • Log in with your credentials
   • Select or create a workspace

2. Dashboard Overview

   • View your assigned issues
   • Check notifications
   • Access recent activity
   • Quick create new issues

Core Features

Issue Management

Creating Issues

1. Click the + New Issue button
2. Fill in required fields:
   • Title: Brief description of the issue
   • Type: Bug, Feature, Enhancement, etc.
   • Priority: Low, Medium, High, Critical
   • Assignee: Person responsible
3. Add optional details:
   • Description with rich text support
   • Labels for categorization
   • Attachments and screenshots
   • Related issues
4. Click Create

Managing Issues

• Status Updates: Change status by dragging cards on the board or using the status dropdown
• Bulk Operations: Select multiple issues and update fields in bulk
• Comments: Add comments to track discussions
• Attachments: Upload files directly to issues
• Subtasks: Break down complex issues into smaller tasks
• Activity / History: Every issue has an activity feed that records who changed what and when — creation, status transitions, comments, links, and field edits (title, description, status, priority, assignee, sprint, story points) with old → new values, newest first

My Issues View

Access all issues assigned to you or reported by you:

• Navigate to My Issues in the sidebar
• Filter by assignee, reporter, status, priority
• Sort by created date, updated date, or due date
• Quick actions: assign, change status, add labels

Filtering the Issue List

Every issue list (Project Issues, My Issues, Custom Views) has a filter bar with four dropdowns — Status, Priority, Type, and Label — plus a title search box:

• Open a dropdown and tick the values you want; the list narrows immediately.
• Active filters appear as removable chips beside the search box. Remove one with its ×, or click Clear all to start over (project scope is kept).
• The current filter, sort, grouping, and visible columns are encoded in the URL, so a filtered list is a shareable link: copy it and open it in a fresh tab to reproduce the identical list.
• The list footer reports “1–50 of N” where N is the true match count, so you know how many issues match before paging.
• Use the Columns button to show or hide columns (key, title, type, status, priority, labels). Key and title are always shown.

Saving Views

• Click Save current view in the issue list to capture the current filters, sort, grouping, and columns under a name.
• Tick Share with team to let anyone in your workspace open the view. A shared view appears for every member; only its owner (or a workspace admin) can rename or delete it.
• Use the ★ to mark a view as your default, so it loads automatically.
• A saved view is indistinguishable from a live filter: opening one just loads its filters into the URL.

Permalinks & Keyboard Navigation

• Every issue has a stable permalink of the form /issues/PROJ-123. Opening it renders the issue page directly (or the detail modal from within a list), and refreshing an open issue keeps the same issue — unknown keys show a clear “not found” state.

• In any issue list, navigate without the mouse:

  Key	Action
  j / k	Move the row cursor down / up
  Enter	Open the focused issue
  x	Toggle selection of the focused issue
  e	Inline-edit the focused issue’s title

• Selecting rows (via the checkboxes or x) reveals a bulk-actions toolbar that reports the count and can set status or assignee across the selection. Partial failures are reported per issue rather than hidden in a single toast.

Board Views

Kanban Board

• Visual representation of your workflow
• Drag and drop issues between columns
• Each column represents a status (To Do, In Progress, Done)
• WIP (Work In Progress) limits per column

Custom Views

1. Navigate to Custom Views
2. Click New View
3. Choose view type:
   • Board: Kanban-style with columns
   • List: Spreadsheet-style view
   • Table: Data-focused table
   • Timeline: Gantt-style timeline
4. Configure:
   • Columns and their status mappings
   • Filters (priority, assignee, labels, etc.)
   • Sort order
   • Grouping options
5. Save as default or shared view

Bulk Editing

1. Select issues using checkboxes
2. Click Bulk Edit
3. Update fields:
   • Status
   • Priority
   • Assignee
   • Labels
   • Due date
4. Confirm changes

Compliance Management

Compliance Templates

Pre-configured templates for common compliance frameworks:

• Security Audit: Review security controls and findings
• GDPR: Data protection and privacy compliance
• SOC2: Security, availability, and processing integrity
• HIPAA: Healthcare data protection
• Financial: Financial regulations and controls

Creating Compliance Reports

1. Navigate to Compliance
2. Select a template or create a new one
3. Configure:
   • Report scope (all projects, specific projects)
   • Schedule (cron expression for automated reports)
   • Recipients (email notifications)
4. Click Generate Report

Viewing Compliance Status

• Overall Score: Percentage compliance
• Control Breakdown: Score per control category
• Findings: Issues requiring attention
• Recommendations: Suggested improvements
• Risk Register: Identified risks and mitigation plans

What the numbers mean: metrics use your tenant’s recorded data. An empty tenant is shown as having insufficient data rather than as fully compliant.

Change Management

Creating Change Requests

1. Navigate to Changes
2. Click New Change
3. Fill in change details:
   • Title: Brief description
   • Type: Standard, Normal, Emergency
   • Priority: Low, Medium, High, Critical
   • Risk Level: Low, Medium, High
   • Impact: Minimal, Moderate, Significant, Major
4. Add implementation details:
   • Implementation plan
   • Backout plan
   • Scheduled start/end times
   • Config items affected
5. Submit for review

Change Workflow

1. Draft: Initial creation
2. Review: Submitted for approval
3. Approved: Ready to schedule
4. Scheduled: Set implementation date
5. In Progress: Being implemented
6. Closed: Successfully completed
7. Failed: Implementation failed, needs review

Change Metrics

Track change management performance:

• Total changes this period
• Approval rate
• Success rate
• Average lead time
• Backout rate

Executive Dashboard

Key Metrics

• Total Projects: Active projects across organization
• Completion Rate: Percentage of issues completed
• Average Cycle Time: Days per issue
• Critical Issues: High-priority items needing attention

Portfolio Overview

• Project health status
• Velocity trends
• Burndown progress
• Team capacity utilization

Risk Register

• Identified risks with severity
• Probability and impact scores
• Mitigation plans
• Risk owners

Collaboration Documents

Collaborative Documents (versioned)

• Create documents attached to an issue, project, or standalone
• Edit the document body; every save creates a new immutable version
• Full version history with one-click restore (restoring is recorded as a new version — nothing is ever lost)

Editing behavior: each save creates an immutable version. When two people save competing edits, the latest save becomes current while earlier versions remain available for restore.

Presence Indicators

• See who is currently active on a document
• Clients send a heartbeat while a document is open; a user is shown as present for 30 seconds after their last heartbeat

Plugin Marketplace

Available Plugins

• Slack Integration: Notifications and issue creation from Slack
• GitHub Integration: Link commits, PRs, and releases to issues
• GitLab Integration: Merge request sync and CI/CD pipelines
• Email to Ticket: Convert emails to issues automatically
• Auto Label: AI-powered label suggestions
• Sprint Analytics: Velocity tracking and predictions
• Custom Dashboard: Build custom widgets and charts
• Import/Export: Migrate from Jira, Asana, Trello

Installing Plugins

1. Navigate to Settings → Plugins
2. Browse available plugins
3. Click Install on desired plugin
4. Configure plugin settings
5. Enable/disable as needed

Security & Single Sign-On (SSO)

Sign-in options (configured by a tenant admin under Settings → Security / SSO):

• Email + password with optional MFA (TOTP): set up via the account security settings; login then requires an MFA challenge.
• Google OAuth — one-click Google sign-in.
• OIDC SSO — connect any OpenID Connect provider (Okta, Entra ID, Auth0, Keycloak, …). The platform reads the provider’s discovery document (/.well-known/openid-configuration) and verifies ID-token signatures against the provider’s published JWKS keys, so tokens can’t be forged.
• SAML 2.0 SSO — download the service-provider metadata from the app and register it with your IdP; supports SP-initiated login and an Assertion Consumer Service (ACS) callback.
• SCIM 2.0 provisioning (enterprise) — automatically create, update, deactivate, and group users/teams from your identity provider using a dedicated SCIM token.

Additional security controls include a configurable password policy, IP access rules, API tokens, and active-session management (view and revoke sessions).

Audit trail integrity: the security/audit log is tamper-evident — entries are linked in a per-tenant cryptographic hash chain, so any modification or reordering of past entries is detectable. Audit data can be exported and streamed to a SIEM via webhooks, with configurable alert rules.

Navigation Guide

Sidebar Navigation

• Dashboard: Overview and quick actions
• My Issues: All your assigned/reported issues
• Executive: High-level metrics and portfolio
• Custom Views: Saved view configurations
• Compliance: Compliance templates and reports
• Changes: Change request management
• Projects: Project list and management
• Notifications: Alerts and updates
• Service Desk: Customer support portal
• Search: Global search across all content
• Portfolio: Portfolio management
• AI: AI-powered features and suggestions
• Security: Security settings and audit log
• Product: Product roadmap and features
• Wiki: Documentation and knowledge base

Command Palette & Keyboard Shortcuts

Press Cmd-K (macOS) or Ctrl-K (Windows/Linux) anywhere to open the command palette — a searchable list of navigation targets and actions. Type to filter, use ↑/↓ to move, Enter to run the highlighted command, and Esc to close. Press ? to open the palette directly on its keyboard-shortcuts help screen.

Global shortcuts fire when you are not typing in an input field. The “g …” shortcuts are two-key chords (press g, then the second key within ~1 second):

These are the shortcuts actually wired up in the app (CommandPalette + data/commands.ts). Additional palette commands without a hotkey are still reachable by opening the palette and searching.

Tips & Best Practices

Issue Management

• Use clear, descriptive titles
• Add detailed descriptions with steps to reproduce
• Set realistic priorities
• Assign issues promptly
• Use labels for better filtering

Board Management

• Keep columns aligned with your workflow
• Set WIP limits to prevent bottlenecks
• Regularly review and update statuses
• Use swimlanes for better organization

Compliance

• Schedule regular compliance reports
• Address findings promptly
• Maintain documentation
• Train team on requirements

Change Management

• Document implementation plans thoroughly
• Always have a backout plan
• Communicate changes to stakeholders
• Review failed changes for improvements

Get help

When reporting a problem to your workspace administrator, include the project or issue key, the action you attempted, and the exact error message.