기술 설명서를 알기 쉽고 번역하기 쉽게 쓰기

## 읽는 사람의 할 일에 맞춰 짧은 문장과 같은 용어로 쓰기 - 대상 독자와 그들의 지식, 과업, 질문을 파악하고 선택지가 있는 경우 각각의 장단점을 설명한다. - 짧고 완전한 문장, 능동태, 현재 시제를 사용하고 절차에서는 명령형 동사를 사용한다. - 하나의 개념에는 하나의 용어만 사용하고 낯선 용어와 약어를 정의하며 관용구, 속어, 고정관념, 특정 지역에만 통하는 비유를 피한다. ## 명령어와 이름은 정확히 옮기고 참고 사항과 경고 나누기 - 대소문자를 포함해 문자 그대로의 식별자를 정확히 보존하고 명령어, 파일 이름, 경로, 사용자 인터페이스의 표시 문구, 일반 문장을 서식에만 의존하지 않고 구분한다. - 의미 있는 예시를 사용하되 실제 계정, 자격 증명, 개인 데이터를 제외하고 지역이나 언어 환경에 민감한 목적이 있다면 설명한다. - 중요한 맥락을 전달하는 참고 사항, 심각한 영향을 알리는 주의 사항, 중대한 결과를 알리는 경고를 구분한다. ## 목록과 표의 형식을 맞추고 단위와 날짜를 분명히 적기 - 제목이 내용을 요약하게 하고 목록을 명확히 소개하며 항목의 구조를 서로 맞추고 순서, 우선순위, 계층을 나타낼 때만 번호를 사용한다. - 표를 단순하게 유지하고 단위를 표시하며 국제단위계를 우선하고 숫자 표기를 일관되게 사용하며 날짜, 시간, 범위, 시간대를 명시한다. - 페이지 번호를 하드 코딩하는 대신 정확하고 안정적인 상호 참조를 사용하고 정의를 그 자체로 이해할 수 있게 하며 용어, 포용성, 법적 고지, 상표를 일관되게 검토한다.