クイックスタートガイド
このガイドでは、Archyl で最初のアーキテクチャダイアグラムをわずか数分で作成する方法を説明します。
ステップ 1:アカウントの作成
- app.archyl.com にアクセスします
- メールアドレスでサインアップするか、GitHub、GitLab、または Bitbucket で接続します
- メールアドレスでサインアップした場合は、メールを確認してください
ステップ 2:最初のプロジェクトの作成
- ダッシュボードで 「新規プロジェクト」 をクリックします
- プロジェクト名を入力します(例:「EC プラットフォーム」)
- 必要に応じて説明とタグを追加します
- 「プロジェクトを作成」 をクリックします
ステップ 3:最初のシステムの追加
- 新しいプロジェクトでは、システムコンテキスト レベルから始まります
- 「+」 ボタンをクリックするか、キャンバス上で右クリックします
- 「システムを追加」 を選択します
- 名前を入力します(例:「EC プラットフォーム」)
- システムの機能の説明を追加します
ステップ 4:外部システムの追加
実際のシステムは孤立して存在しません。ソフトウェアが連携する外部システムを追加しましょう:
- 「+」 をクリックし、「外部システムを追加」 を選択します
- 「決済ゲートウェイ」、「メールサービス」、「CDN」などのシステムを追加します
- これらは外部であることを示す異なるスタイルで表示されます
ステップ 5:関係の作成
システム間の通信方法を示します:
- ソースシステムをクリックします
- 接続ポイントからターゲットシステムにドラッグします
- 関係を説明するラベルを追加します(例:「API 経由で決済処理」)
ステップ 6:コンテナへのズームイン
メインシステムをダブルクリックして、コンテナレベルに深入りします:
- 「Web アプリケーション」、「API サーバー」、「データベース」などのコンテナを追加します
- それらの間の通信方法を示します
- 外部システムに接続します
次のステップ
おめでとうございます!最初のアーキテクチャダイアグラムを作成しました。次に探索できることは以下の通りです:
- リポジトリの接続 - AI にアーキテクチャを自動的に発見させる
- AI ディスカバリー - AI がコードベースを分析する方法を学ぶ
- チームコラボレーション - チームメンバーを招待する
- エクスポートと共有 - ステークホルダーとダイアグラムを共有する
成功のヒント
- 高レベルから始める:詳細に入る前にシステムコンテキストから始めましょう
- 明確な名前を使う:システムとコンテナに説明的な名前を付けましょう
- 説明を追加する:将来のあなた(とチーム)が感謝するでしょう
- 反復する:アーキテクチャドキュメントは生きたものです——システムの進化に合わせて更新しましょう