구체적으로 쓰기
모호하거나 불필요하게 장황한 표현은 독자의 이해를 방해하고, 중요한 정보를 빠르게 파악하기 어렵게 만들어요. 특히 기술 문서에서는 독자가 필요한 정보를 즉각적으로 찾고 적용할 수 있어야 하기 때문에, 불분명한 표현을 줄이고 직접적이고 구체적인 문장을 작성하는 것이 중요해요.
체크리스트
✅ 명사 대신 동사를 사용하세요
동사는 명사보다 더 직접적이고 간결하게 독자가 무엇을 해야 하는지에 대한 아이디어를 전달합니다. 특히, 동사에서 파생된 명사(예: "설정 수행", "검토 진행")는 의미가 흐릿해지니 되도록 사용하지 않는 게 좋아요.
Don't
코드 최적화 진행 후 배포 수행이 필요합니다.
- '진행', '수행' 같은 불필요한 명사가 포함됐어요.
Do
코드를 최적화한 후 배포하세요
Don't
MongoDB 연결 정보 설정 및 초기화가 필요합니다.
- 의미가 함축된 명사가 많고, 어떤 작업을 해야 하는지 명확하지 않아요.
Do
MongoDB에 연결할 호스트와 포트를 설정하고 데이터베이스를 초기화합니다.
✅ 모호한 표현 대신 명확한 표현을 사용하세요
'가능성이 있다', '일부 경우', '필요할 수도 있다' 같은 모호한 표현을 사용하면 독자가 정확한 의미를 파악하기 어려워져요. 문서의 신뢰도를 위해 확실한 정보를 제공하세요.
Don't
설정 파일을 변경하면 기존 설정이 영향을 받을 수도 있습니다.
일부 브라우저에서 정상적으로 동작하지 않을 가능성이 있습니다.
Do
설정 파일을 변경하면 기존 설정이 삭제됩니다.
Internet Explorer에서는 정상적으로 동작하지 않습니다.
실습 문제
아래 문장을 명확하게 수정해보세요. 문제를 풀었다면 답안을 확인해서 비교해 보세요.
1. 명사 대신 동사로 바꿔보세요.
데이터 백업 진행 후 시스템 설정 변경이 필요합니다.
설정 변경 완료 후에는 서비스 재시작 수행이 요구됩니다.
정답 확인
데이터를 백업하고 나서 시스템 설정을 A로 바꿔주세요. 설정을 올바르게 바꾼 뒤에 서비스를 다시 시작해 주세요.
2. 모호한 표현을 명확한 표현으로 바꿔보세요.
일부 환경에서는 소프트웨어 설치 후 정상적으로 실행되지 않을 가능성이 있습니다.
이 경우 추가 구성이 필요할 수도 있습니다.
정답 확인
Windows 7과 같은 구형 운영체제에서는 소프트웨어를 설치해도 실행되지 않을 수 있습니다.
이럴 때는 .NET Framework 4.8을 수동으로 설치해야 합니다.