Integration Handbook

What is the Integration Handbook?

The Integration Handbook is a shared tool between the customer and the integration developers that defines ways to develop integrations and APIs. It unambiguously defines the practices and development models agreed with the customer. The Integration Handbook is made specifically for your organization and defines how you do things.

"The integration manual is always tailored to the customer's needs in terms of content and scope."

A HiQ consultant interviews the client about their existing practices and server environments. Based on the information received from the client, the consultant writes a manual that is reviewed by the client. Based on customer comments, the manual will be iteratively modified until accepted by the customer. This manual will then be used as an integration development manual.

What is included in the integration manual?

In addition to customer-specific instructions, we include our suggestions in the Integration Handbook for:

• Naming conventions

• Methods of publishing and distributing APIs

• General guidelines for choosing different integration methods for each use case

• Delivery Model and how to use it (e.g. Kan-Ban, scrum or waterfall)

• Make and manage requirements and specifications with examples

• List and agreement of things to be defined before starting work (Definition -of-Ready)

• List and agreement of what needs to be done before a single integration can be called and

• assigned to a client (Definition-or-Done)

• Documentation site and examples