ドキュメント

Archylの使い方を学ぶ。

Getting started

  • Archyl の紹介 — Archyl とは何か、C4 モデルを使用してソフトウェアアーキテクチャをドキュメント化する方法を学びましょう
  • クイックスタートガイド — 5 分で Archyl を始めましょう - 最初のアーキテクチャダイアグラムを作成
  • コアコンセプト — Archyl で使用される主要な概念と用語を理解しましょう

C4 model

Features

  • AI によるディスカバリー — Archyl が AI を使ってコードベースからアーキテクチャを自動的に発見・ドキュメント化する仕組みについて — プッシュごとのインクリメンタル更新も含みます
  • アーキテクチャ変更リクエスト — 構造化された変更リクエストワークフローを通じてC4アーキテクチャモデルへの変更を提案、レビュー、マージ
  • ドキュメントとADR — Archylでアーキテクチャドキュメントとアーキテクチャ決定記録を作成・管理
  • ドキュメントの添付ファイル — ドラッグ&ドロップ、貼り付け、または添付ボタンでドキュメントページに画像やファイルをアップロード — S3 互換のオブジェクトストレージに安全に保存
  • ユーザーフロー — アーキテクチャ全体のインタラクションのシーケンスを可視化するユーザーフローとデータフローのドキュメント化
  • コードとしてのアーキテクチャ — archyl.yamlでC4アーキテクチャを定義・同期 — バージョン管理、CI/CD対応、完全な宣言型
  • アーキテクチャ・タイムラプス — プロジェクトのバージョン履歴を映画のように再生 — 要素が自ら描かれ、廃止されたサービスに取り消し線が入り、エンドクレジットが流れます。そのままブラウザ内だけでレンダリングして 1080p の MP4 として書き出せます
  • アーキテクチャインサイト — アーキテクチャの問題を自動検出し、システム設計改善の推奨事項を取得
  • 共有とエクスポート — ステークホルダーとのアーキテクチャダイアグラムの共有と各種フォーマットへのエクスポート
  • APIコントラクト — C4アーキテクチャ要素に直接リンクされたAPI仕様のドキュメント化と管理
  • リリース管理 — GitHub Actions、Webhook、REST API を使用した自動取り込みで、アーキテクチャ全体のデプロイメントを追跡
  • マーケットプレイス連携 — 外部サービスを接続して、アーキテクチャと共にライブメトリクス、アラート、ダッシュボードを表示
  • プロダクションリアリティ(リビングダイアグラム) — Kubernetes、Datadog、New Relic などの本番ソースを接続して稼働中のサービスと依存関係を検出し、それらを C4 モデルと突き合わせて整合させます — 読み取り専用かつ非破壊的
  • テクノロジーレーダー — テクノロジーランドスケープの可視化、採用レベルの追跡、すべてのプロジェクト全体での技術スタックの管理
  • Webhook 通知 — プロジェクトでアーキテクチャの変更が発生した際に、リアルタイムの HTTP 通知を受信
  • Slack & Teams ボット — Slack や Microsoft Teams からアーキテクチャについて Archyl に質問し、ライブ MCP ツールで回答・操作させましょう
  • オーナーシップマップ — インタラクティブなバブル、依存関係ライン、カバレッジトラッキングでアーキテクチャ全体のチームとユーザーの所有権を可視化
  • 適合性ルール(ガードレール) — C4 モデル、技術的な意思決定、コーディング標準に照らしてコード変更を検証する決定論的なアーキテクチャルールを定義します — AI は一切使いません
  • GitHub Actions 統合 — Archyl の公式 GitHub Actions で、アーキテクチャ適合性チェック、ドリフトスコアリング、コンテキスト生成などを CI/CD パイプラインで実行します
  • 適合性ルールパック — 一般的なアーキテクチャパターン向けの構築済み適合性ルールセット — マイクロサービス、クリーンアーキテクチャ、イベント駆動、API ファースト、セキュリティベースライン
  • マネージドエージェント実行 — スケジュールに基づいて動作する自律型AIエージェントを起動し、MCPコネクタで外部サービスと連携させ、完全なアーキテクチャコンテキストを持ってコードベース上で作業させます
  • 独自の AI プロバイダー — Archyl のすべての AI 機能を独自のプロバイダー(OpenAI、Anthropic、Google Gemini、AWS Bedrock、または任意の OpenAI 互換エンドポイント)経由で独自の認証情報を使用してルーティング — そして Archyl のクォータ制限をスキップ。
  • AI 利用状況と従量課金 — 組織の AI トークン利用状況をリアルタイムで確認し、月間クォータを超えても AI 機能を使い続けられます。超過分はトークン単位で、設定した月間上限まで課金されます。
  • コマンドパレット — Cmd+K を押すと、1 つの入力欄からアーキテクチャを検索し、アクションを実行できます。任意のページを開く、決定やドキュメントを作成する、ディスカバリーやエージェントの実行を開始する、といった操作が可能です。

Guides

  • 最初のプロジェクトの作成 — Archyl で最初のアーキテクチャプロジェクトを作成し、ドキュメント化するためのステップバイステップガイド
  • ダイアグラムの埋め込み — インタラクティブな Archyl ダイアグラムを Confluence、Notion、Miro などのプラットフォームに埋め込む
  • セキュリティ — Archyl がデータとアーキテクチャ情報をどのように保護するかを学びましょう
  • 設定と構成 — AI プロバイダーの設定、サブスクリプションの管理、Archyl 体験のカスタマイズ
  • コーディングエージェントスキル — Archylの11個のコーディングエージェントスキルをインストールして、Claude Code、Codex、または互換性のあるエージェントから直接アーキテクチャを検証・文書化・レビュー・最適化する方法
  • Archyl Harness — あらゆるコーディングエージェントを5分でアーキテクチャ対応に。絞り込まれたコンテキスト、統制された作業セッション、Guardrails の強制、そしてエージェント間で積み上がるメモリ
  • Archyl CLI — オープンソースの archyl コマンドライン。ファイルを C4 モデル上に位置づけ、ブランチの影響範囲と知らせるべき相手を確認し、ターミナルからコーディングエージェントをハーネスの下で実行します

Git integration

  • Git 統合の概要 — Git リポジトリを接続して AI 搭載のアーキテクチャディスカバリーを有効にしましょう

Collaboration

  • チーム管理 — Archylでチームを作成・管理し、コラボレーションを向上させる方法
  • リアルタイムホワイトボード — チームとリアルタイムでアーキテクチャダイアグラム上でコラボレーション
  • チームアーキテクチャダイジェスト — ドリフト、ADR、コンフォーマンス、ディスカッションなど、アーキテクチャのアクティビティをまとめたメールを各チームに定期送信します。
  • 通知 — 対応が必要なことを Archyl がどのように知らせるかを説明します。あなたの対応を待っているものを集めるアプリ内の受信トレイと、アーキテクチャの変更を知らせるオプトイン式のメール通知があります。
  • アクティビティログ — 組織内で行われたすべての変更を確認し、対象の要素を開いて、何が変わったかをフィールドごとに読めます。履歴ページまたは要素の詳細パネルから利用できます。
  • メンション、引用、リンク — @ で人を名指しし、# で要素・意思決定・ページを引用し、どこで引用されているかを確認し、Archyl と Slack でプレビューとして開くリンクを共有します。
  • フォロー — 要素、意思決定、プロジェクトをフォローすると、その変更、コメント、変更リクエストが受信トレイに届きます。オーナーは所有するものを自動的にフォローします。
  • タスク — コメントを、担当者、任意の期限、チェックボックスを持つタスクに変え、自分のタスクを受信トレイと各要素で確認します。
  • ダイアグラム上のコメント — ダイアグラムの好きな場所にディスカッションをピン留めできます。空白、要素、リレーションシップのどこでも、表示中のレベルに置けます。番号付きのバブル、返信、解決に対応しています。

Api

  • API概要 — Archyl APIとツールやワークフローへの統合方法について
  • 認証 — APIキーを使用したArchyl APIの認証方法について
  • MCPサーバー — Claude、Cursor、VS CodeなどのAIアシスタントをアーキテクチャに接続 — C4モデル、ADR、コントラクト、コンフォーマンス、ドリフト、DORAなどを網羅した181のツール
  • SDK — 公式のNode.js SDKとPython SDKによるArchyl APIへのプログラムからのアクセス