Home / ドキュメント

Documentation

読む人に合わせた、
ドキュメント。

経営層向けの紹介から、技術担当者向けの解説、開発者向けのガイドライン、AI コーディングエージェント用の skill まで。すべて GitHub のリポジトリにあります。

For engineers

技術解説（技術担当者向け）

📘

Biz Assistant Framework 技術解説

構成・Bridge v1 と manifest・主な流れ・安全の約束・つなぎ方と作り方・品質と提供状況。日本語・English・中文で読めます。

Web で読む →Markdown ↗

For developers

開発ガイドラインとアーキテクチャ

🛠️

開発ガイドライン（GUIDELINE.md）

チェックリスト・手順・拡張点・MUST / SHOULD の規則・テスト・版の管理・FAQ。業務システムをつなぐときの正本。日本語・English・中文で読めます。

Web で読む →Markdown ↗

🏗️

アーキテクチャ（ARCHITECTURE.md）

業務面と AI 面・5 つの層・event の流れ・身元と委託・受信者の保証・安全と個人情報の約束。

読む ↗

For AI coding agents

導入 skill

🧩

biz-assistant-integration

Claude Code などの AI コーディングエージェントに、新規・既存の業務システムへの導入（診断 → 計画 → manifest・hooks・event → 適合性テスト → 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 adapter、fixtures の書き方。

README ↗

server-kit

hooks・ストア・別名・外部連携・添付の変換。

README ↗

見本の業務システム

設備点検（server-kit の上で作った例。適合性テスト 52 / 52・e2e）。

examples ↗

For decision makers

紹介資料

経営層向け紹介（図解）

記録するシステムを、考えて動くシステムに。21 枚と 8 枚の精簡版。

PDF / PPTX ↗

運用AI Bot 技術概要

システムを見守り、直し、育てる姉妹製品の技術資料。

詳しく →

読む人に合わせた、ドキュメント。