Integration Specification + Runbook PackageKyle Tully
Most SaaS integrations run for years without anyone knowing how they work or why they were built that way.
This package changes that — with two documents, built from your codebase.
The integration specification answers "how was this designed?" — business purpose, data model, field mappings, source of truth, and design assumptions.
The operational runbook answers "what do we do when it breaks?" — monitoring signals, failure modes, triage steps, and recovery guidance.
They're written to reference each other, serving different readers for different situations.
What's included:
Integration specification: scope, data flow, field mappings, error handling design, dependencies
Operational runbook: monitoring signals, failure modes, recovery steps, escalation guidance
Context and sequence diagrams
Delivered as Markdown. Notion and Confluence-ready.
Best for teams migrating an integration, onboarding a new engineer, or documenting ahead of an audit.
Covers: n8n, Celigo, Make, Salesforce, HubSpot, Zendesk, NetSuite, Atlassian.
FAQs
Kyle's other services
Starting at$850
Duration10 days
Tags
API Documentation
Business Workflow Automation
Documentation
Integration
Technical Writer
Specification
Service provided by
Kyle Tully proOttawa, Canada
- 1
- Followers
Integration Specification + Runbook PackageKyle Tully
Starting at$850
Duration10 days
Tags
API Documentation
Business Workflow Automation
Documentation
Integration
Technical Writer
Specification
Most SaaS integrations run for years without anyone knowing how they work or why they were built that way.
This package changes that — with two documents, built from your codebase.
The integration specification answers "how was this designed?" — business purpose, data model, field mappings, source of truth, and design assumptions.
The operational runbook answers "what do we do when it breaks?" — monitoring signals, failure modes, triage steps, and recovery guidance.
They're written to reference each other, serving different readers for different situations.
What's included:
Integration specification: scope, data flow, field mappings, error handling design, dependencies
Operational runbook: monitoring signals, failure modes, recovery steps, escalation guidance
Context and sequence diagrams
Delivered as Markdown. Notion and Confluence-ready.
Best for teams migrating an integration, onboarding a new engineer, or documenting ahead of an audit.
Covers: n8n, Celigo, Make, Salesforce, HubSpot, Zendesk, NetSuite, Atlassian.
FAQs
Kyle's other services
$850