Archyl の紹介 - Archyl Docs

Archyl とは何か、C4 モデルを使用してソフトウェアアーキテクチャをドキュメント化する方法を学びましょう

Archyl の紹介

Archyl は、ソフトウェアチームが C4 モデル を使用してシステムアーキテクチャを可視化、ドキュメント化、維持するための AI 搭載アーキテクチャドキュメントプラットフォームです。

C4 モデルとは?

C4 モデルは、Simon Brown が作成したソフトウェアアーキテクチャドキュメントの階層的アプローチです。4 つの抽象レベルで構成されています:

  1. システムコンテキスト(レベル 1):ユーザーや外部システムを含む、システムが周囲の環境にどのように適合するかを示します
  2. コンテナ(レベル 2):システムにズームインし、高レベルの技術的構成要素(アプリケーション、データストア、マイクロサービス)を示します
  3. コンポーネント(レベル 3):コンテナを構成コンポーネントに分解します
  4. コード(レベル 4):コンポーネントをクラスや関数などの実際のコード要素にマッピングします

主な機能

AI 搭載のディスカバリー

Git リポジトリを接続し、Archyl の AI にアーキテクチャを自動的に発見・ドキュメント化させましょう。AI はコードベースを分析して以下を特定します:

  • システムとその境界
  • コンテナ(サービス、データベース、メッセージキュー)
  • コンポーネントとその関係
  • コードレベルの要素

インタラクティブなダイアグラム

チームが以下のことができる美しいインタラクティブなアーキテクチャダイアグラムを作成します:

  • 抽象レベル間のナビゲーション
  • パンとズームで大規模なアーキテクチャを探索
  • PNG、SVG、または PDF にエクスポート
  • Confluence、Notion、またはあらゆるウェブサイトに埋め込み

チームコラボレーション

チームと一緒にアーキテクチャをドキュメント化します:

  • さまざまなロール(管理者、編集者、閲覧者)でチームメンバーを招待
  • 履歴で変更を追跡
  • ステークホルダーと公開リンクを共有

アーキテクチャインサイト

アーキテクチャに関する自動化されたインサイトを取得します:

  • 潜在的な問題を特定
  • ADR でアーキテクチャ決定を追跡
  • ユーザーフローをドキュメント化
  • 依存関係を監視

はじめに

アーキテクチャのドキュメント化を始める準備はできましたか?クイックスタートガイドに従って、数分で最初のプロジェクトを作成しましょう。

ユースケース

Archyl は以下に最適です:

  • エンジニアリングチーム マイクロサービスアーキテクチャのドキュメント化
  • アーキテクト ステークホルダーへのシステム設計の伝達
  • DevOps チーム デプロイメント全体の理解
  • 新しいチームメンバー 複雑なシステムへのオンボーディング
  • テクニカルライター アーキテクチャドキュメントの作成

次のステップ