이 빠른 시작은 Microsoft Learn에서 게시할 기술 콘텐츠를 작성하는 간단한 가이드입니다. 이러한 지침은 새로운 설명서를 만들거나 기존 설명서를 업데이트하는 경우에 적용됩니다.
모범 사례:
- Microsoft Word에 복사하고 붙여넣은 후 맞춤법과 문법을 확인해야 하는 경우에도 문서의 맞춤법과 문법을 확인합니다.
- 다른 사람과 일대일로 대화하는 것처럼 편안하고 친숙한 음성을 사용합니다.
- 간단한 문장을 사용합니다. 읽기 쉬운 문장이란 귀하가 공유하는 지침을 독자가 빨리 사용할 수 있음을 의미합니다.
Microsoft 음성 원칙을 사용합니다.
Microsoft Learn에 대한 기술 콘텐츠를 작성할 때 이러한 원칙을 따르기를 열망합니다. 완벽하지 못할 수는 있지만 노력은 해야 하지 않을까요?
- 의도에 집중: 고객은 특정 목적을 가지고 문서를 참고합니다. 작성하기 전에 고객을 특정하고 고객이 원하는 작업이 무엇인지 분명히 결정합니다. 그런 다음 해당 특정 고객이 특정 작업을 수행하도록 돕는 문서를 작성합니다.
- 일상적 단어 사용: 자연스러운 언어, 고객이 사용하는 단어를 사용하도록 노력하세요. 공식적인 표현보다 기술적 표현이 중요합니다. 새로운 개념을 설명하는 예제를 제공하세요.
- 간결하게 작성: 단어를 낭비하지 마세요. 긍정문을 사용하고 추가 단어나 수식어를 많이 사용하지 않습니다. 문장을 짧고 간결하게 씁니다. 문서에 초점을 맞춥니다. 작업에 수식어가 있다면 문장이나 문단의 처음에 배치합니다. 또한 참고 사항의 수를 최소로 줄입니다. 단어를 저장할 때 스크린샷을 사용합니다.
- 쉬운 문서 검색: 가장 중요한 내용을 먼저 배치합니다. 섹션을 사용하여 긴 절차를 더욱 관리하기 쉬운 단계 그룹으로 자릅니다. (12단계를 초과하는 절차는 너무 깁니다.) 명확성을 보강하는 스크린샷을 사용합니다.
- 공감 표시: 문서에서 협력적인 어조를 사용하고 부정적인 표현은 최소로 줄입니다. 고객이 불만스러울 수 있는 영역을 솔직하게 드러냅니다. 기술적인 내용만 기술하지 않고 고객에게 중요한 사항에 집중하도록 합니다.
로컬라이제이션 및 기계 번역 고려
본사의 기술 문서는 여러 언어로 번역되고 일부는 특정 시장 및 지역에서 수정됩니다. 누군가는 웹 상에서 기계 번역을 사용하여 기술 문서를 읽을 수도 있습니다. 따라서 문서를 작성할 때 다음과 같은 지침에 유의하세요.
- 문서에서 문법, 맞춤법 또는 문장 부호 오류를 범하지 않음: 당연히 그래야 합니다. Markdown 일부 버전(예: Markdown Pad 2.0)에는 기본 맞춤법 검사가 있지만 맞춤법 및 문법 검사가 더 강력한 Word에 렌더링된 HTML 콘텐츠를 붙여넣는 것이 좋습니다.
- 최대한 짧은 문장: 문장이 복잡하거나 절이 연속되면 번역이 어렵습니다. 문장이 장황하거나 이상하게 들리지 않도록 나눕니다. 문장을 부자연스럽게 작성하지 않도록 하세요.
- 간단하고 일관적인 문장 구조 사용: 번역하려면 일관적인 문장이 좋습니다. 삽입 어구나 별도 문장 대신 주제를 최대한 문장의 처음에 가까이 씁니다. 몇 가지 게시된 문서를 체크 아웃합니다. 친근하고 쉽게 읽을 수 있는 문서를 모델로 사용합니다.
- 일관적인 단어 및 대/소문자 사용: 다시 언급하지만 일관성이 중요합니다. 문장 처음에 있는 단어나 고유 명사가 아닌 경우 대문자로 시작하지 않습니다.
- "간단한 단어" 포함: 영어에서 문맥을 파악하는 데 참고하지만 중요하지 않게 생각하는 단어(예: "a", "the", "that", "is")는 기게 번역에 중요합니다. 반드시 포함하도록 합니다.
확인할 기타 스타일 및 음성 문제
- 설명 또는 별도 문장으로 단계를 나누지 않습니다.
- 코드 조각을 포함한 단계의 경우 단계에 대한 추가 정보를 코드에 의견으로 배치합니다. 그러면 읽어야 하는 텍스트의 양이 감소합니다. 중요 정보는 코드 프로젝트로 복사되므로 나중에 코드를 참조할 때 코드의 기능을 알려줄 수 있습니다.
- 모든 제목에는 문장의 첫 글자를 대문자로 사용합니다.
- "log in"이 아니라 "sign in"을 사용합니다.
- 자세한 지침은 Microsoft 작성 스타일 가이드를 참조하세요.
로컬라이제이션된 문서
- 지역화된 설명서에 기여하는 경우 세계화 참조를 참조하세요.
- 로컬라이제이션 지침, 기술 게시에서 언어 스타일 및 사용에 대한 정보 및 특정 시장 데이터 형식에 대한 정보는 해당 언어의 스타일 가이드를 다운로드합니다.
- Microsoft Terminology를 방문하여 제품별 승인 용어를 검색하거나 해당 언어로 Microsoft Terminology Collection을 다운로드합니다.
- 지역화에 대한 자세한 내용은 Microsoft 작성 스타일 가이드의 “Global communications”(글로벌 커뮤니케이션)를 참조하세요.
참고 항목
지역화된 대부분 설명서는 GitHub를 통해 피드백을 편집하거나 제공하는 기능을 제공하지 않습니다. 지역화된 콘텐츠에 대한 피드백을 제공하려면 양식을 사용합니다 https://aka.ms/provide-feedback .