Adobe Experience Platform에서 대상 문서화
개요 overview
Adobe Experience Platform에 오신 것을 환영합니다. 여기에 오신 것을 환영합니다!
대상을 문서화하는 것은 Adobe Experience Platform에서 라이브로 설정하기 전에 마지막 단계입니다.
이 설명서 섹션에는 다음이 포함됩니다.
- 새 대상에 대한 설명서 페이지를 만드는 단계별 지침
- 대상을 위해 작성할 템플릿
- Markdown 사용에 대한 일반 지침;
- Adobe Markdown 향에 대한 특정 지침(Adobe Markdown 향은 일반 Markdown과 매우 유사함).
- Experience Platform 문서 품질 표준을 충족하는 대상 페이지의 문서 페이지를 작성하는 데 도움이 되는 모범 사례 페이지입니다.
전제 조건 prerequisites
이 문서의 지침에 따라 대상에 대한 설명서를 만들려면 다음 항목이 필요합니다.
- GitHub 계정. 아직 계정이 없으면 GitHub에 등록하세요.
- GitHub 데스크톱. 로컬 환경에서 설명서를 만들기를 선택하는 경우 GitHub Desktop을 사용해야 합니다.
- Adobe과의 통합은 Adobe Experience Platform의 스테이징 환경에 배포된 대상과의 테스트 단계에 있어야 합니다.
Adobe Experience Platform에서 대상에 대한 설명서를 만드는 고급 지침 high-level-instructions
대략적으로 대상에 대한 설명서를 만들려면 Adobe Experience Platform 설명서 리포지토리의 포크를 만들고 새 분기에서 제공된 설명서 템플릿을 편집해야 합니다. Adobe 제공 템플릿을 사용하여 새 대상 페이지를 만듭니다. 준비가 되면 가져오기 요청(PR)을 엽니다. 이 작업을 수행하는 지침은 새 대상 페이지를 만드는 단계의 아래에 나와 있습니다.
설명서 템플릿 documentation-template
설명서 페이지를 만드는 데 도움이 되도록 Adobe이 설명서 템플릿을(를) 미리 채웠습니다. 아래에서 템플릿을 편집하고 가져오기 요청을 여는 방법에 대한 지침을 확인할 수 있습니다. Adobe 설명서 팀이 새 대상에 대한 설명서를 검토하고 게시합니다.
여기에서 템플릿을 다운로드하고 파일의 압축을 해제하여 yourdestination.md 파일을 추출합니다.
템플릿 을 사용하여 설명서 페이지를 만드는 방법은 아래에 나와 있습니다.
새 대상 페이지를 만드는 단계 steps-to-create-docs-page
GitHub 웹 인터페이스 또는 로컬 환경을 사용하여 Adobe Experience Platform의 새 대상에 대한 설명서를 만들 수 있습니다. 아래 링크에서 두 옵션에 대한 지침을 확인하십시오.
모범 사례 best-practices
대상 설명서 페이지를 만들기 전과 만드는 동안 작성 모범 사례를 검토하십시오. Adobe 설명서 팀이 설명서를 작성할 때 사용하는 자세한 작성 팁은 Adobe 설명서에 대한 작성 지침도 참조하십시오.