#문장의 주체를 분명하게 하기

기술 문서를 읽는 독자는 주로 개발자예요. 또, 개발 문서에 적힌 작업을 직접 하는 것도 개발자죠. 따라서 기술 문서에서는 문서를 읽는 사람이 곧 행동의 주체예요. 명시적으로 드러내지 않더라도, 문맥에서 개발자가 주체임을 고려하면 더 자연스럽고 명확한 문장이 돼요.

#체크리스트

#✅ 도구나 기술, 시스템을 행동의 주체로 사용하지 않아요

문서에서 설명하는 목표와 작업을 수행하는 사람은 개발자예요. 그래서 도구나 기술 자체를 문장의 주어로 사용하면 어색할 때가 있어요.

이 문서를 읽고 개발자가 할 수 있는 일을 중심으로 설명해 보세요.

다만, 도구나 기술의 동작을 설명하고 싶을 때는 문장의 주체가 도구나 기술이 될 수 있어요. 다음 예시와 같은 상황이에요.

Impression 로그는 두 가지 방식으로 동작해요.

1. 특정 접근성 요소가 화면에 나타나면 자동으로 수집돼요.
2. 특정 DOM 요소를 직접 지정해서 뷰포트에 나타날 때 로그를 수집할 수 있어요.

#✅ 능동형으로 표현해요

수동형 문장은 문장을 복잡하게 만들고, 주체가 불분명해질 수 있습니다. 능동형 문장을 사용하면 문장이 직관적이고 이해하기 쉬워져요.