가이드라인을 통해 다음의 용어들을 이해할 수 있습니다:
- 아키텍처 보드
- Azure Developer Experience Architecture Board는 애저 서비스를 액세스하는 데 사용되는 클라이언트 라이브러리를 조언하고 리뷰하는 언어 전문가로 이루어져 있습니다.
- 애저 SDK
- 애저 서비스에 액세스할 때 사용되는 단일 대상 언어에 대한 client libraries 모음입니다.
- 애저 코어
- 많은 클라이언트 라이브러리의 종속성입니다. 애저 코어 라이브러리는 애저 SDK에 전체적으로 적합한 파이프라인, 일반적인 자격 증명 형식, 그리고 다른 유형에 대한 액세스를 제공합니다.
- 클라이언트 라이브러리
- 애저 서비스 작업을 쉽게하기 위해 _consumers_가 사용하는 라이브러리(및 관련 도구, 문서, 샘플). 일반적으로 애저 서비스 그리고 대상 언어 당 하나의 클라이언트 라이브러리가 있습니다. 가끔 단일 클라이언트 라이브러리는 다수의 서비스를 연결할 수 있는 기능을 포함합니다.
- 소비자
- 다양한 유형의 개발자들을 구분하기 위해 우리는 앱에서 클라이언트 라이브러리를 사용하여 애저 서비스에 연결하는 개발자를 표시하기 위해 _consumer_라는 용어를 사용합니다.
- Docstrings
- 구현중인 API 표면을 설명하는 코드에 포함된 주석입니다. 빌드 중에 _docstrings_를 추출하고 사전 처리하여 API 참조 문서를 생성합니다.
- 라이브러리 개발자
- 다양한 유형의 개발자들을 구분하기 위해 우리는 클라이언트 라이브러리를 작성하는 개발자를 표시하기 위해 _library developer_라는 용어를 사용합니다.
- 패키지
- 소비자들에게 배포할 수 있도록 패키지된 클라이언트 라이브러리입니다. 패키지는 일반적으로 패키지 리포지토리의 패키지 관리자를 사용하여 설치됩니다.
- 패키지 리포지토리
- 각 클라이언트 라이브러리는 해당 언어별 패키지 리포지토리에 별도로 게시됩니다. 예를 들어, npmjs.org에는 자바스크립트 라이브러리(NPM Registry)를, PyPI에서는 파이썬 라이브러리를 배포합니다. 이러한 릴리스는 애저 SDK 엔지니어링 팀만이 수행합니다. 소비자는 패키지 관리자를 통하여 패키지를 설치합니다. 예를 들어 자바스크립트는 yarn, npm등을 사용할 수 있고 파이썬 소비자는
pip을 사용하여 프로젝트에 패키지를 설치할 수 있습니다. - 프로그레시브 컨셉 공개
- 클라이언트 라이브러리와의 첫 번째 상호 작용은 고급 서비스 컨셉들에 의지해서는 안됩니다. 라이브러리의 소비자가 더 능숙해짐에 따라, 우리는 소비자가 구현을 위해 그러한 개념을 필요로 하는 시점에 필요한 개념을 공개합니다. Progressive Disclosure는 Nielson Norman Group이 더 좋은 사용자 인터페이스를 설계하기 위한 접근으로 처음 논의되었습니다.
요구사항
이 문서의 요구사항들은 라벨로 표시되어 있고 상대적 중요성을 나타내기 위해 색상으로 구분되어 있습니다. 중요도가 높은 순으로 작성되었습니다:
✅ DO 클라이언트 라이브러리에 요구사항을 사용해주세요. 만약 예외가 필요하다면 구현전에 Architecture Board와 상의해주세요.
⛔️ DO NOT 클라이언트 라이브러리에 요구사항을 사용하지 말아주세요. 만약 예외가 필요하다면 구현전에 Architecture Board와 상의해주세요.
☑️ YOU SHOULD 클라이언트 라이브러리에 요구사항을 강력하게 고려해야합니다. 만약 이 권장사항을 따르지 않을 경우, 반드시 Architecture Board 디자인 리뷰를 할 때 차이를 공개해야합니다.
⚠️ YOU SHOULD NOT 클라이언트 라이브러리에 요구사항을 강력하게 고려하지 말아야합니다. 만약 이 권장사항을 따르지 않을 경우, 반드시 Architecture Board 디자인 리뷰를 할 때 차이를 공개해야합니다.
✔️ YOU MAY 만약 여러분의 상황에 적절할 경우 이 권장사항을 고려해야합니다. 아키텍처 보드에 통보할 필요가 없습니다.