Home / 文档

Documentation

为不同读者准备的
文档。

从面向管理层的介绍，到面向技术人员的解说、面向开发者的指南、供 AI 编程智能体使用的 skill，都在 GitHub 仓库中。

For engineers

技术解说（面向技术人员）

📘

Biz Assistant Framework 技术解说

架构、Bridge v1 与 manifest、主要流程、安全承诺、接入与开发、质量与提供状况。提供日文、英文、中文三种语言。

在线阅读 →Markdown ↗

For developers

开发指南与架构

🛠️

开发指南（GUIDELINE.md）

检查清单、步骤、扩展点、MUST / SHOULD 规则、测试、版本管理、FAQ——接入业务系统时的正本。提供日文、英文、中文三种语言。

在线阅读 →Markdown ↗

🏗️

架构（ARCHITECTURE.md）

业务面与 AI 面、五个层次、事件流、身份与委托、收件人保证、安全与个人信息的承诺。

阅读 ↗

For AI coding agents

导入 skill

🧩

biz-assistant-integration

引导 Claude Code 等 AI 编程智能体，把框架导入新系统或既有系统的操作手册（诊断 → 计划 → manifest · hooks · 事件 → 一致性测试 → AI 面配置 → 业务 Web → 完成条件）。

阅读 ↗

install the skill

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

Reference

参考

Bridge v1 OpenAPI

packages/protocol/openapi/bridge-v1.yaml —— 用其他语言实现时的正本。

YAML ↗

协议与一致性测试

52 项检查一览、通用 HTTP 适配器、fixtures 的写法。

README ↗

server-kit

hooks、存储、别名、外部连接、附件转换。

README ↗

示例业务系统

设备点检（基于 server-kit 开发；一致性测试 52 / 52、端到端测试）。

examples ↗

For decision makers

介绍资料

面向管理层的介绍（图解）

把只会记录的系统，变成会思考、会行动的系统。21 页与 8 页精简版。

PDF / PPTX ↗

运维 AI Bot 技术概要

守护、修复并培育系统的姊妹产品的技术资料。

了解更多 →

为不同读者准备的文档。