Documentation

Everything Catalio does, written down.

How Catalio extracts what your platforms already know, turns it into a living specification, and keeps it current as the software changes. Guides, concepts and API references in one place.

Quick start → How Catalio works

67 articles · 7 topics · updated

New · MCP Authentication

The journey

Extract. Understand. Evolve.

Three concepts, three guides

01 · Extract Connect and extract Link a repository, API or metadata export. Every field, endpoint, rule and job comes in with an AI summary and semantic tags. How Catalio works → 02 · Understand The living specification Features, requirements and policies reverse-engineered from the inventory. Always current, structured, and searchable by purpose. Read the concept → 03 · Evolve Gap analysis and modernization Compare what the legacy system actually does against what the target needs. Missing rules, new capabilities, behaviour changes. Gap analysis →

Browse by topic

7 shelves, every article on one of them.

Getting Started 3 Connect your first application and create a living specification in minutes 01Welcome to Catalio 02Quick Start Guide 03Your First Catalio Workflow All 3 → How It Works 4 Understand Catalio's approach: Extract institutional knowledge, create living specifications, and evolve with confidence 01How Catalio Works 02The Living Specification 03Gap Analysis & Risk-Free Modernization 04Driving Catalio from Your IDE over MCP All 4 → Platform Catalog 34 How Catalio organizes your extracted business rules, requirements, and institutional knowledge ApplicationsFeaturesRequirementsPersonasUse CasesTest Cases & ResultsComponentsJourneysJourney StepsJobs To Be Done (JTBD)Journey ComparisonsDiscovery Sessions + 22 more All 34 → Use Cases 5 Real-world scenarios: legacy modernization, regulated industries, enterprise transformations 01Enterprise Software Development 02Regulated Industries: Healthcare, Finance & Pharma 03Product Management & Roadmap Planning All 5 → Integrations 14 Connect Catalio with your legacy systems, enterprise platforms, and modern development tools 01GitHub Integration 02Linear Integration 03Salesforce Integration (Beta) All 14 → Collaboration 4 Share living specifications, manage access, and collaborate across teams 01Understanding Sharing and Access Control 02Managing Access to Your Resources 03Permission Levels Reference All 4 → API Guides 3 Integrate Catalio's API into your migration and documentation workflows 01API Authentication 02JSON:API Overview 03MCP Authentication All 3 →

All articles

Guides, references and tutorials, by topic.

Platform Catalog

How Catalio organizes your extracted business rules, requirements, and institutional knowledge

34

Applications

Learn how Catalio models the legacy or target software system you are analyzing, modernizing, or documenting

application legacy-modernization journeys

Features

Scan-derived functional areas within an application that group requirements once a domain expert confirms them

features requirements application

Requirements

Learn how Catalio structures business requirements using user story format with AI-powered features

requirements user-stories ai

Personas

Define user roles and stakeholders to create targeted, user-centered requirements

personas user-roles stakeholders

Use Cases

Create testable scenarios using Gherkin format to validate your requirements

use-cases acceptance-criteria gherkin

Test Cases & Results

Create comprehensive test cases to validate requirements, then record and track execution results to build quality confidence over time

test-cases test-results testing

Components

The atomic pieces of an Application — metadata in a business platform or files in a source repository, sometimes both at once

components metadata source-files

Journeys

Record step-by-step sequences of how users actually interact with your software to identify friction, gaps, and improvement opportunities

journeys user-experience legacy-modernization

Journey Steps

Understand how individual user actions are captured, classified, and analyzed for friction within Catalio journeys

journey-steps friction user-experience

Jobs To Be Done (JTBD)

Capture the deeper motivations behind user behavior to ensure journeys and requirements are grounded in real business goals

jtbd jobs-to-be-done personas

Journey Comparisons

Link a legacy journey to a target journey for the same job-to-be-done and quantify the UX improvement step-by-step

journey-comparisons journeys legacy-modernization

Discovery Sessions

Structure and track AI-assisted discovery conversations that systematically extract requirements and friction insights from subject matter experts

discovery sessions ai

Capabilities

Organize requirements and processes around discrete business capabilities that transcend technology changes and org chart reorganizations

capabilities business-architecture requirements

Processes

Organize requirements into sequential workflows using templates and deployment tracking

processes workflows templates

Initiatives

Understand how Initiatives organize all discovery, requirements, and delivery work into a governed, stage-gated modernization engagement

initiatives strategy stages

AI Chat

Have natural-language conversations with an AI assistant that can read, create, and update your requirements catalog — right inside Catalio

ai chat conversations

Document Extraction

Upload documents and let Catalio's AI analyze them against your codebase or specification, producing Change Proposals for your team to review

ai document-extraction artifacts

Initiative Questions

Capture open questions, blockers, and decisions that surface during an Initiative and track them through resolution so nothing falls through the cracks

questions blockers decisions

Capability Assessments

Score each Capability within an Initiative on a 1–5 scale to produce a Red/Yellow/Green heatmap of transformation readiness and drive gap analysis

capability-assessments heatmap scoring

Change Proposals

Review, accept, and apply AI-discovered requirement changes from document extraction, journey analysis, and stakeholder discovery

change-proposals ai discovery

AI Grader

Understand how Catalio grades requirements across Clarity, Completeness, Feasibility, and Quality — and how to act on low scores

ai grader requirements

AI Classifier

After capturing a journey, Catalio's AI classifies it against existing JTBDs and personas, identifies friction points, and surfaces structured improvement suggestions

ai classifier journeys

Decisions

Capture the formal choices made during an Initiative — what you're building, how you're building it, and how you work — with type-specific templates, supersede chains, and ADR export

decisions adr architecture

AI Skills

AI Skills give the Catalio assistant different areas of expertise — from requirements writing to security analysis — and are selected automatically based on what you ask

ai skills chat

Organizations

Understand how Catalio isolates data and manages access across enterprise boundaries

organizations multi-tenancy security

Teams

Group users by function or domain to manage requirement implementation and accountability

teams organization collaboration

Users

Control access and permissions through user roles and authentication providers

users roles permissions

Policies

Define organizational constraints, link them to requirements, and keep governance context in the living specification

policies governance compliance

Sources

Link Slack channels, GitHub repositories, MS Teams channels, and other data feeds to automatically surface requirements from real-world conversations and code

sources slack github

Artifacts

Attach notes, comments, file uploads, and diagrams to any Requirement, Initiative, Application, or other entity in Catalio

artifacts notes comments

Versioning

Understand the versioning patterns Catalio uses — explicit Application Versions, paper-trail change tracking, and the superseding pattern for Requirements

versioning application-versions paper-trail

Issue Links

Connect Catalio Requirements, Applications, and Initiatives to GitHub Issues, Linear, Jira, and Azure DevOps work items to close the loop between specifications and delivery

issue-links traceability github

Repositories

Connect source code repositories to Catalio to automatically surface Components from your codebase and map them to Applications for code-level traceability

repositories github source-code

Notifications

Receive in-app and email alerts when something in Catalio needs your attention — mentions, comments, proposal queues, component sync events, and announcements — with per-type preferences and quiet hours

notifications inbox preferences

Integrations

Connect Catalio with your legacy systems, enterprise platforms, and modern development tools

14

GitHub Integration

Connect Catalio to GitHub to link requirements with issues, pull requests, and commits for complete development traceability.

integrations github version-control

Linear Integration

Link Catalio records to Linear issues with automatic metadata sync through Issue Links.

integrations linear issues

Salesforce Integration (Beta)

Connect and sync Salesforce metadata into Catalio's Extract, Understand, and Evolve workflow. Available today in Beta.

integrations salesforce beta

Azure DevOps Integration

Link Catalio records to Azure DevOps work items with automatic metadata sync through Issue Links.

integrations azure-devops work-items

Slack Integration Administration

Administrator guide for installing, configuring, and managing the Catalio Slack integration.

integrations slack installation

Slack Agent Usage Guide

Learn how to interact with the Catalio Slack Agent to manage requirements, personas, and use cases through natural conversation.

slack integrations chat

Microsoft Teams Integration Administration

Administrator guide for installing, configuring, and managing the Catalio Microsoft Teams bot integration.

integrations microsoft-teams teams

Microsoft Teams Agent Usage Guide

Learn how to interact with the Catalio Microsoft Teams bot to manage requirements, personas, and use cases through natural conversation.

microsoft-teams teams integrations

Building Custom Integrations

Connect proprietary and legacy systems to Catalio using the live REST API and polling workflows. Outbound webhooks are planned.

integrations api custom

Supported AI Providers

Complete reference of all AI/LLM providers Catalio can connect to when bring-your-own-LLM is enabled for your organization, including capabilities, model availability, and configuration requirements.

integrations ai llm

Bring Your Own LLM (BYOLLM)

Connect your organization's own AI provider in Catalio. Available per organization on request; by default your workspace uses the managed Catalio AI provider. Learn how to set up API keys, select models, and manage provider configurations securely.

integrations ai llm

AI Features and Data Privacy

How Catalio protects your data when using AI features. Learn about encryption, data handling, and compliance considerations.

integrations ai privacy

ServiceNow Integration

ServiceNow integration is on the Catalio roadmap. Today you can connect requirements to issues with the GitHub and Linear integrations.

integrations servicenow itsm

Jira Integration

Jira integration is on the Catalio roadmap. Today you can link requirements to issues with the GitHub and Linear integrations.

integrations jira agile

See it on your system

Read enough? Watch it run on your code.

A 30-minute working session: connect one system, watch the extraction, read the first requirements together.

Book a demo →