사용자 흐름 - Archyl Docs

아키텍처 전반에 걸친 사용자 및 데이터 흐름을 문서화하여 상호작용 시퀀스를 시각화하세요

사용자 흐름

Archyl의 사용자 흐름을 사용하면 아키텍처 전반에 걸친 상호작용 시퀀스를 문서화할 수 있습니다. 사용자, 데이터 또는 요청이 시스템을 통해 어떻게 이동하는지 시각화하세요.

흐름이란?

흐름은 아키텍처를 통한 일련의 단계를 나타냅니다:

  • 사용자 여정: 로그인, 결제, 가입
  • 데이터 흐름: 주문 처리, 데이터 동기화
  • 시스템 상호작용: API 호출, 이벤트 체인
  • 오류 처리: 실패 시나리오, 재시도

흐름의 각 단계는 아키텍처의 관계를 참조하여 작동 방식에 대한 연결된 뷰를 제공합니다.

흐름 생성

흐름 탭에서

  1. 프로젝트에서 흐름 탭으로 이동합니다
  2. 흐름 생성을 클릭합니다
  3. 이름과 설명을 입력합니다
  4. 관계를 선택하여 단계를 추가합니다
  5. 저장을 클릭합니다

흐름 구조

각 흐름에는 다음이 포함됩니다:

필드 설명
이름 간결하고 설명적인 이름 (예: "사용자 로그인 흐름")
설명 이 흐름이 나타내는 것
단계 관계 참조의 정렬된 목록

단계 추가

각 단계에 대해:

  1. 아키텍처에서 관계를 선택합니다
  2. 단계에 소스, 대상 및 관계 레이블이 표시됩니다
  3. 드래그하여 단계 순서를 변경합니다
  4. 추가 맥락을 위한 메모를 추가합니다

흐름 보기

단계별 탐색

흐름을 볼 때:

  • 단계가 순서대로 표시됩니다
  • 현재 단계가 다이어그램에 강조 표시됩니다
  • 다음/이전 버튼으로 탐색합니다
  • 각 단계에서 전체 맥락을 확인합니다

애니메이션 재생

재생을 클릭하여 흐름을 애니메이션으로 봅니다:

  • 자동 단계 진행
  • 다이어그램에 강조된 경로
  • 조절 가능한 재생 속도

흐름 공유

공개 흐름 링크

사용자 흐름에는 내장 공개 공유 기능이 있습니다:

  1. 흐름을 엽니다
  2. 공유 아이콘을 클릭합니다
  3. 공개 URL을 복사합니다
  4. 누구에게나 공유합니다

공개 뷰에는 다음이 포함됩니다:

  • 단계별 탐색
  • 아키텍처 시각화
  • 흐름 설명
  • 인증 불필요

흐름 임베딩

외부 도구에 흐름을 임베드합니다:

  • Confluence
  • Notion
  • 문서 사이트
  • 위키

모범 사례

흐름 이름을 명확하게

행동 지향적인 이름을 사용하세요:

  • "사용자 등록"
  • "주문 결제 프로세스"
  • "결제 환불 흐름"
  • "데이터 동기화 파이프라인"

흐름을 집중적으로 유지

  • 사용자 여정당 하나의 흐름
  • 5-15단계가 이상적
  • 복잡한 흐름은 하위 흐름으로 분리
  • 필요 시 다른 흐름 참조

맥락 추가

설명을 사용하여 다음을 설명하세요:

  • 이 흐름이 존재하는 이유
  • 누가 사용하는지
  • 언제 트리거되는지
  • 예상되는 결과

문서에 연결

관련 문서를 참조하세요:

  • API 명세
  • 요구사항 문서
  • 설계 선택을 설명하는 ADR

흐름 예시

전자상거래 결제

  1. 사용자 → 장바구니 서비스: "장바구니 보기"
  2. 장바구니 서비스 → 재고: "재고 확인"
  3. 사용자 → 결제 서비스: "결제 시작"
  4. 결제 서비스 → 결제: "결제 처리"
  5. 결제 → 주문 서비스: "주문 생성"
  6. 주문 서비스 → 알림: "확인 메일 전송"

API 인증

  1. 클라이언트 → API 게이트웨이: "자격 증명으로 요청"
  2. API 게이트웨이 → 인증 서비스: "토큰 검증"
  3. 인증 서비스 → 사용자 DB: "사용자 조회"
  4. 인증 서비스 → API 게이트웨이: "클레임 반환"
  5. API 게이트웨이 → 백엔드: "사용자 컨텍스트와 함께 전달"

다음 단계