Docker 확장 설계 가이드라인

Docker 확장 설계 가이드라인 (Design guidelines for Docker extensions)

확장을 만들 때 Docker가 권장하는 설계 가이드라인을 설명하는 문서예요.

출처: 문서

본문

Docker에서 우리는 사용자가 새 워크플로우를 채택하도록 요구하기보다는, 기존 워크플로우에 통합되는 도구를 만드는 것을 목표로 해요. 확장을 만들 때 다음 가이드라인을 따르기를 강력히 권장해요. 우리는 이 요구사항에 따라 Marketplace 게시를 검토하고 승인해요.

확장을 만들 때 확인해야 할 간단한 체크리스트예요:

  • 시작하기 쉬운가요?
  • 사용하기 쉬운가요?
  • 필요할 때 도움을 받기 쉬운가요?

Docker Desktop과 일관된 경험 만들기 (Create a consistent experience with Docker Desktop)

  • 사용자에게 매끄러운 경험을 만들기 위해 Docker Material UI Theme와 Docker Extensions Styleguide를 사용해 확장이 Docker Desktop의 일부인 것처럼 느껴지게 하세요.
  • 확장에 라이트와 다크 테마가 모두 있는지 확인하세요. Docker 스타일 가이드에 따라 컴포넌트와 스타일을 사용하면 확장이 level AA 접근성 표준을 충족하게 돼요.
  • 확장 아이콘이 라이트와 다크 모드 모두에서 보이는지 확인하세요.
  • 탐색 동작이 Docker Desktop의 나머지와 일관되는지 확인하세요. 확장의 맥락을 설정하는 헤더를 추가하세요.
  • 터미널 창을 임베드하지 마세요. CLI보다 Docker Desktop이 갖는 장점은 사용자에게 풍부한 정보를 제공할 기회가 있다는 거예요. 이 인터페이스를 최대한 활용하세요.

기능을 네이티브하게 구축하기 (Build features natively)

사용자의 흐름을 방해하지 않기 위해, 사용자가 특정 기능을 수행하기 위해 Docker Desktop 밖(예: CLI나 웹페이지)으로 이동해야 하는 시나리오를 피하세요. 대신 Docker Desktop에 네이티브한 기능을 구축하세요.

복잡한 사용자 흐름 분해하기 (Break down complicated user flows)

흐름이 너무 복잡하거나 개념이 추상적이라면, 흐름을 각 단계에 하나의 간단한 행동 유도(call-to-action)가 있는 여러 단계로 분해하세요. 이는 확장에 처음 온 사용자를 온보딩하는 데 도움이 돼요.

여러 행동 유도가 있을 때는 각 동작의 중요성을 전달하기 위해 기본(채워진 버튼 스타일)과 보조(윤곽 버튼 스타일) 버튼을 사용하세요.

새 사용자 온보딩 (Onboarding new users)

확장을 만들 때 확장과 제품에 처음 온 사용자가 그 가치를 이해하고 쉽게 채택할 수 있도록 하세요. 확장 안에 맥락에 맞는 도움말(contextual help)을 포함시키세요.

Extensions Marketplace와 확장 세부 정보 페이지에 필요한 모든 정보가 추가되었는지 확인하세요. 여기에는 다음이 포함되어야 해요:

  • 확장의 스크린샷. 권장 크기는 2400x1600 픽셀이라는 점에 유의하세요.
  • 확장의 목적이 무엇인지, 누가 유용하게 사용할지, 어떻게 동작하는지 다루는 상세한 설명.
  • 문서 같은 필요한 리소스에 대한 링크.
  • 확장에 특히 복잡한 기능이 있다면 시작 페이지에 데모나 비디오를 추가하세요. 이는 첫 사용자를 빠르게 온보딩하는 데 도움이 돼요.

다음은 무엇인가요?

더 알아보기 (Learn more)