Skip to content

Latest commit

 

History

History
92 lines (52 loc) · 5.99 KB

guidelines.md

File metadata and controls

92 lines (52 loc) · 5.99 KB
source-git-commit workflow-type source-wordcount ht-degree
2d90738d01fef6e37a2c25784ed4d1338c037c23
ht
715
100%

Adobe Experience Manager 설명서에 대한 기여 지침

설명서 철학

Adobe Experience Manager 사용자는 경쟁이 치열한 환경에서 경쟁업체와 차별화된 디지털 경험을 제작하기 위해 노력하고 있습니다. 따라서 Adobe가 AEM에서 새로운 고급 도구를 제공할 때 고객이 즉시 AEM 투자를 활용하고 투자 수익률을 극대화할 수 있도록 정확하고 명확한 설명서로 이들 도구를 보완하는 것이 중요합니다.

AEM 설명서의 목표는 가능한 한 빨리 설명서를 AEM 사용자에게 전달하는 것입니다. 따라서 Adobe에서는 정확하고 유용한 문서를 제공하는 것을 최우선으로 하며 이를 지속적으로 업데이트하고 개선하기 위해 노력하고 있습니다.

설명서 기여

AEM 설명서를 지속적으로 개선하기 위해 AEM 사용자 전체 커뮤니티에서 설명서에 대한 기여를 환영하고 있습니다. 가져오기 요청이나 문제를 통해 수행되는 설명서의 개선 사항은 수정, 분류, 해명 및 추가 예제가 될 수 있습니다.

설명서 표준

Adobe에서는 설명서에 대한 고객의 기여를 환영하지만 당사의 가져오기 요청이나 문제의 형태로 AEM 설명서에 대한 기여를 할 때는 Adobe의 기여 및 설명서 표준을 준수해야 합니다.

이러한 표준을 충족하지 않는 기여는 거부될 수 있습니다.

Adobe는 표준 사용 사례를 문서화합니다.

AEM 설명서에서는 표준 사용 사례를 다룹니다. 표준 설치 및 제품 사용 범위를 벗어나는 사용 사례는 AEM 설명서에 포함되지 않습니다.

Adobe는 일반적으로 버그나 해결 방법은 문서화하지 않습니다.

AEM 설명서에서는 표준 사용 사례를 다룹니다. 따라서 버그, 버그로 인한 효과 및 버그에 대한 해결 방법은 문서화되지 않습니다.

이 규칙의 예외는 릴리스 정보입니다. 릴리스 정보에서는 알려진 문제를 AEM 제품 관리에서 승인한 사용 가능한 해결책과 함께 나열할 수 있습니다.

설명서 기여는 기술 관련 질문에 대한 답변을 위한 자료가 아닙니다.

AEM 설명서를 개선하기 위해 필요한 모든 아이디어를 기여할 수 있습니다. 그러나 주석, 문제 및 가져오기 요청만 기여​에 해당합니다. 하지만 기여는 AEM 사용 방법, AEM 프로젝트 구현 방법, 기술 문제 해결 방법 등에 대한 질문에 답변하기 위한 것이 아닙니다.

AEM 사용 또는 기술 오류에 대한 질문은 Experience Cloud 기업 지원 포털을 통해 일반적인 지원 프로세스를 통해 보고하거나 Experience Manager 커뮤니티에서 다룰 수 있습니다.

AEM 설명서 기여는 Adobe 고객 지원 센터를 대체할 수 없으며 지원 관련 질문에 대한 답변을 구하는 기여는 거부됩니다.

기여는 해당 설명서 페이지를 명확하게 참조해야 합니다.

설명서에 대한 개선 사항을 제안하는 문제를 만드는 경우 영향을 받는 페이지에 대한 링크를 포함해야 합니다. 설명서 페이지에서 이 페이지 편집 링크를 사용하여 문제를 만들면 페이지에 대한 링크가 자동으로 문제와 함께 생성됩니다.

가져오기 요청은 기본적으로 영향을 받는 페이지를 참조하므로 해당 사항은 가져오기 요청에 적용되지 않습니다.

설명서 지침

Adobe 설명서에 대한 모든 기여는 특정 스타일 지침을 따르도록 요구합니다.

다음 지침을 따르면 귀하가 기여한 내용을 더 쉽게 검토할 수 있으므로 Adobe 설명서에 빠르게 통합할 수 있습니다.

언어 및 스타일

언어

  • AEM 설명서는 미국 영어로 작성 및 관리됩니다.
  • 가능하면 문장을 단순하게 유지하십시오.
  • 언어를 명확하고 간결하게 사용해야 합니다.

AEM 설명서의 독자는 전 세계에 분포되어 있으므로 영어를 모국어로 하지 않을 수 있고 유창하게 구사하지 못할 수 있음을 기억해야 합니다. 구어체 사용을 피하고 가능한 한 명확하고 단순한 언어를 사용하십시오.

Microsoft® 스타일 설명서 따라하기

Microsoft® 스타일 설명서는 소프트웨어 설명서에 중점을 둔 무료 설명서 스타일 안내서이며 AEM 설명서는 가능한 이 안내서를 따릅니다.

서식

항목 스타일
UI 요소 또는 옵션 굵게
파일 이름, 경로, 사용자 입력, 매개변수 값 monospaced
코드, 명령줄 Code Block

스크린샷

스크린샷은 텍스트 설명이 불충분한 경우에만 주의해서 사용해야 합니다.

스크린샷의 마커 또는 기타 주석(예: 빨간색 프레임, 화살표 또는 텍스트)은 사용할 수 없습니다. 이렇게 스크린샷은 번역된 버전의 설명서에서 다시 사용하거나 복제하는 것이 더 쉽습니다.

버전별 참조

가능하면 설명서 내용 전체에서 특정 버전에 대한 직접 참조를 사용하지 마십시오. 이를 통해 설명서를 보다 유연하고 향후 버전에 맞게 확장할 수 있습니다.

Day, AEM, CQ, CRX 사용

제품을 문서에서 처음 언급될 때는 항상 전체 이름 Adobe Experience Manager​를 표시해야 하며 그 이후에는 AEM​으로 언급될 수 있습니다.

Day, Day Software, CQ 및 CRX는 클래스 이름이나 AEM의 작업 내역을 참조하는 등 불가피한 경우를 제외하고는 사용하지 않아야 합니다.