Home / Docs
Documentation

Docs for
every reader.

From the introduction for executives to the technical guide for engineers, the developer guideline and the skill for AI coding agents — all in the GitHub repository.

For engineers

Technical guide (for engineers)

📘

Biz Assistant Framework technical guide

Architecture, Bridge v1 and the manifest, main flows, safety promises, connecting and building, quality and status. Available in Japanese, English and Chinese.

For developers

Developer guideline and architecture

🛠️

Developer guideline (GUIDELINE.md)

Checklist, steps, extension points, MUST / SHOULD rules, testing, versioning, FAQ — the reference for connecting a business system. Available in Japanese, English and Chinese.

🏗️

Architecture (ARCHITECTURE.md)

Business and AI planes, five layers, event flow, identity and delegation, recipient guarantees, safety and privacy promises.

For AI coding agents

Integration skill

🧩

biz-assistant-integration

A runbook that guides AI coding agents such as Claude Code through bringing the framework into a new or existing system (assess → plan → manifest · hooks · events → conformance → AI plane → web app → done checks).

install the skill
cp -r docs/skill/biz-assistant-integration ~/.claude/skills/
# then ask: "Bring Biz Assistant Framework into this system"
Reference

Reference

Bridge v1 OpenAPI

packages/protocol/openapi/bridge-v1.yaml — the reference for implementations in other languages.

YAML ↗

Protocol and conformance suite

The 52 checks, the generic HTTP adapter, how to write fixtures.

README ↗

server-kit

Hooks, stores, aliases, connectors, attachment conversion.

README ↗

Sample business system

Equipment inspection (built on server-kit; conformance 52 / 52, e2e).

examples ↗
For decision makers

Introductions

Executive introduction (diagrams)

Turn systems that record into systems that think and act. 21 slides and an 8-slide version.

PDF / PPTX ↗

Ops AI Bot technical overview

Technical material for the sister product that watches over, fixes and grows systems.

Learn more →