문서 스타일 가이드

스타일 가이드는 문서 작성자와 언어 편집자 모두를 위해 설계되었습니다.스타일 가이드는 콘텐츠 품질, 일관성 및 가독성을 위해 전반적으로 적용되어야 합니다.

미리

먼저 시청자를 이해해야 합니다.콘텐츠는 다양한 기술적 배경과 기술을 갖춘 시청자에게 노출됩니다.초보 독자와 숙련된 독자 모두 작업에 액세스할 수 있도록 하세요.
주제를 신중하게 선택하십시오.콘텐츠는 이 주제를 중심으로 구성되어야 합니다.
콘텐츠 유형을 이해했는지 확인하세요.예를 들어 콘텐츠가 단계별 자습서, 기술 개요 또는 일반 대중을 위한 에세이입니까?
콘텐츠의 범위와 전제 조건을 정하세요.
피팅 스타일 가이드를 채택하세요.

작가가 일반 영어를 사용하고 독자가 내용을 쉽게 이해할 수 있도록 권장합니다.콘텐츠를명확하게, 간결하게 유지하는 것이 도움이 될 수 있습니다.
단락이 통일된 주제에 맞게 구성되어 있는지 확인하세요.문장은 짧고 문법적으로 견고하며 언어적으로 일관성이 있어야 합니다.
우리는 포용적인 표현을 보편적인 표현 스타일로 사용하는 것을 장려합니다.

미국식 영어가 일반적으로 선호됩니다.
새 용어의 경우 단어의 철자 뒤에 약어를 입력하십시오.RESTful API 및 HTML과 같은 일반적인 약어의 경우 지정할 필요가 없습니다.
글의 어조는 주제 및 목적과 일치해야 합니다.좀 더 개인적인 어조를 만들고 싶다면 두 번째 인칭을 사용하세요.
가능하면 액티브 보이스가 패시브 보이스보다 좋습니다.
현재 시제를 사용하여 초안을 작성하십시오.
다음을 포함하는 문법에 특히 주의를 기울이십시오.
미국 영어 철자.예를 들어, “센터” 대신 “센터”를 사용하십시오.
확정된 기사 및 무기한 기사.제목 및 제목에서 이러한 문서를 제외할 수 있습니다.
올바른 대문자 사용.제목과 제목에는 대/소문자를 사용하십시오.
대명사는 명확한 표시가 있어야 합니다.예를 들어, “최고의 탐색적 데이터 분석 도구입니다”라고 해서 “해당 도구”가 누구인지는 알 수 없습니다.모호함과 혼동을 피하려면 문장을 “RATH는 최고의 탐색 데이터 분석 도구”로 다시 작성하십시오.
일반적인 가이드라인에 따라 문장 부호가 정확한지 확인하세요.

초안을 작성했으니 이제 프로세스의 절반이 끝났습니다.콘텐츠를 제출하기 전에 다음과 같은 언어 편집 단계를 완료했는지 확인하세요.

RATH Doc Center는 도큐사우루스를 콘텐츠 관리 플랫폼으로 사용합니다.

많은 기술 문서 작성자와 프로그래머에게 널리 사용되는 마크업 언어인 Markdown을 사용하여 문서를 만들고 편집할 수 있습니다.

문의하기 를 통해 제출 워크플로를 설정할 수 있습니다.