프로젝트 내보내기 및 가져오기: 완전히 이식 가능한 아키텍처

우리는 아키텍처 문서가 당신의 것이라고 믿습니다. 독점 형식에 잠겨 있지 않고, API 뒤에 갇혀 있지 않으며, 구독 티어에 볼모로 잡혀 있지 않습니다. 시스템, 컨테이너, 컴포넌트, 관계를 문서화하는 데 시간을 투자했다면, 그 작업을 가져갈 수 있어야 합니다.

오늘, 그 믿음을 구체화합니다. Archyl은 이제 완전한 프로젝트 내보내기와 가져오기를 지원합니다.

하나의 파일에 모든 것

프로젝트를 내보내면 전체 C4 모델이 포함된 단일 JSON 파일을 받습니다. 정의한 모든 시스템, 시스템 내의 모든 컨테이너, 모든 컴포넌트, 그 깊이까지 모델링했다면 코드 레벨 요소까지. 설명과 기술 어노테이션이 포함된 연결 관계. 다이어그램을 그룹화하고 정리하기 위해 만든 시각적 오버레이.

내보내기는 다이어그램의 공간 레이아웃을 보존합니다. 구조를 명확하게 전달하기 위해 요소를 배치하는 데 시간을 들였습니다 — API 게이트웨이는 왼쪽에, 데이터베이스는 오른쪽에, 외부 시스템은 상단에. 그 배치는 무작위가 아닙니다; 아키텍처를 전달하는 방식의 일부입니다. 내보내기는 이 모든 것을 캡처합니다.

형식은 버전이 매겨지고 문서화된 간단한 JSON입니다. 어떤 텍스트 에디터에서든 열어서 읽을 수 있습니다. 커스텀 작업을 원하면 스크립트로 파싱하세요. 당신이 제어하는 형식의 당신의 데이터입니다.

내보내기 작동 방식

접근 권한이 있는 프로젝트를 열고, 내보내기 옵션으로 이동하여 형식을 선택합니다. 데이터 이식성을 위해 JSON을 선택합니다. 파일이 즉시 다운로드됩니다 — 수백 개의 요소가 있는 대형 프로젝트도 몇 초 만에 내보냅니다.

다른 사용 사례를 위한 시각적 내보내기도 지원합니다. SVG는 Illustrator에서 편집하거나 문서에 삽입할 수 있는 벡터 형식을 제공합니다. PNG는 공유 가능한 이미지를 제공합니다. PDF는 전문적인 문서를 만듭니다. 네 가지 C4 레벨을 모두 하나의 포괄적인 내보내기로 결합하는 옵션도 있습니다.

자동화를 위해 API 엔드포인트는 예상대로 작동합니다. /projects/{id}/export에 대한 GET 요청이 완전한 JSON 페이로드를 반환합니다. CI 파이프라인에 통합하고, 주간 백업을 예약하거나, 이미 가진 어떤 워크플로우에든 통합하세요.

가져오기는 새로운 프로젝트를 생성합니다

아키텍처를 가져오면 Archyl은 완전히 새로운 프로젝트를 생성합니다. 이름과 슬러그를 제공하고, 선택적으로 팀을 선택한 후, JSON 파일을 업로드합니다. 시스템이 내보내기를 파싱하고, 구조를 검증하며, 새로운 식별자로 모든 요소를 재생성합니다.

이것은 의도적인 설계 선택입니다. 가져오기는 기존 프로젝트에 병합하거나 충돌을 조정하려 하지 않습니다. 소스와 독립적인 깨끗한 사본을 만듭니다. 원래 프로젝트는 변경되지 않고 계속 존재하며, 가져온 프로젝트는 자체적인 삶을 시작합니다.

가져오기 프로세스는 ID 리매핑의 복잡성을 투명하게 처리합니다. 내보내기에는 요소가 생성될 때의 원래 UUID가 포함됩니다. 가져오기는 요소 간의 관계를 유지하면서 모든 것에 대해 새 UUID를 생성합니다. 특정 시스템에 속한 컨테이너는 여전히 그 시스템에 속합니다. 두 컴포넌트를 연결하는 관계는 여전히 연결합니다. 구조는 동일합니다; 식별자만 변합니다.

내보내기의 관계가 존재하지 않는 요소를 참조하는 경우 — 부분 내보내기나 손상된 파일의 경우 — 가져오기는 경고를 기록하고 계속합니다. 가져올 수 있는 모든 것을 받으며, 건너뛴 것에 대한 가시성이 있습니다.

실제 사용 사례

우리와 함께 일하는 컨설팅 회사는 내보내기를 사용하여 클라이언트에게 아키텍처 문서를 제공합니다. Archyl에서 클라이언트의 시스템을 모델링하고, 디스커버리와 수동 문서화를 통해 다듬은 후, 최종 결과를 내보냅니다. 클라이언트는 자체 Archyl 인스턴스로 가져오거나 단순히 참여 기록으로 보관할 수 있는 JSON 파일을 받습니다.

엔터프라이즈 플랫폼 팀은 매주 아키텍처를 내부 백업 시스템으로 내보냅니다. 기본 문서에 문제가 발생하면 최신 내보내기에서 복원할 수 있습니다. JSON 형식은 백업이 읽기 가능하고 검증 가능하다는 것을 의미합니다. 불투명한 바이너리 블롭이 아닙니다.

한 스타트업은 인수 중에 내보내기를 사용했습니다. 인수 회사는 대상의 시스템 아키텍처를 이해해야 했습니다. 수주간의 지식 전달 미팅을 예약하는 대신, 팀은 Archyl 프로젝트를 내보내고 파일을 공유했습니다. 인수자들은 가져와서 대화식으로 탐색했고, 무엇을 구매하는지 실제로 이해한 상태로 통합 논의에 참석했습니다.

개발 팀은 내보내기를 아키텍처 스냅샷으로 사용합니다. 주요 릴리스 후 현재 상태를 내보내고 코드와 함께 JSON 파일을 커밋합니다. 몇 달 후 누군가 "마이크로서비스 마이그레이션 전에 아키텍처가 어떻게 생겼었나?"라고 물으면, 답은 git checkout 하나면 됩니다.

내보내는 것

내보내기에는 완전한 C4 계층이 포함됩니다. 최상위의 시스템, 내부에 중첩된 컨테이너, 컨테이너 내의 컴포넌트, 컴포넌트 내의 코드 요소. 각 요소는 전체 메타데이터를 포함합니다: 이름, 설명, 유형, 기술 스택, 태그, 위치 좌표, 커스텀 스타일링.

관계는 양쪽 엔드포인트가 명시되어 내보내지며, 유형, 설명, 레이블 위치 같은 시각적 속성이 포함됩니다. 가져오기 프로세스는 이를 새로 생성된 요소에 매핑하여 정확한 연결 구조를 유지합니다.

오버레이 — 복잡한 다이어그램을 정리하기 위해 만드는 시각적 그룹핑 — 는 위치, 크기, 색상, 포함된 요소와 함께 포함됩니다.

현재 내보내지 않는 것: ADR, 프로젝트 문서, 사용자 플로우, 리포지토리 연결. 내보내기는 C4 모델 자체에 초점을 맞춥니다 — 시스템, 컨테이너, 컴포넌트, 코드, 그리고 그들의 관계. 사용자가 필요하다고 알려주는 것을 기반으로 향후 릴리스에서 범위를 확장하는 것을 고려하고 있습니다.

락인 없음, 속임수 없음

내보내기 형식은 현재 "1.0" 버전을 사용합니다. 기능을 추가하면서 이전 버전과의 호환성을 유지하면서 형식을 업데이트할 것입니다. 오늘 만든 내보내기는 Archyl이 진화하더라도 수년 후에도 올바르게 가져올 수 있습니다.

데이터를 가두는 데 관심이 없습니다. 당신이 머물기를 선택할 만큼 유용한 것에 관심이 있습니다. 내보내기와 가져오기는 그 철학에 대한 우리의 약속입니다. Archyl이 더 이상 적합한 도구가 아니라면, 아키텍처를 가져가세요. 경쟁사가 더 나은 것을 만들면, 쉽게 전환할 수 있도록 만들었습니다. 계속 신뢰를 얻어야 하는 압력은 우리에게 있습니다.

시작하기

내보내기와 가져오기는 무료를 포함한 모든 플랜에서 사용할 수 있습니다. 인위적인 제한 없음, "내보내기는 프리미엄 기능" 게임 없음.

내보내려면: 프로젝트를 열고, 내보내기 버튼을 찾고, JSON을 선택하고, 파일을 저장합니다.

가져오려면: 프로젝트 목록에서 가져오기를 클릭하고, JSON 파일을 업로드하고, 새 프로젝트에 이름을 붙이고, 확인합니다.

아키텍처 문서는 당신의 것입니다. 이제 어디든 가져갈 수 있습니다.

Archyl에서 무엇을 문서화할 수 있는지 더 알고 싶으신가요? C4 모델 소개를 읽거나, AI 기반 아키텍처 디스커버리가 기존 시스템을 자동으로 매핑하는 방법을 확인하세요.