기능 중심의 설명보다는 독자가 얻을 수 있는 가치를 먼저 설명하는 것이 좋아요. 독자가 문서를 읽고 어떤 문제를 해결할 수 있는지, 어떤 긍정적인 변화를 기대할 수 있는지 먼저 전달해야 해요.
문서를 작성할 때 많은 사람이 기능이나 세부 설정을 먼저 설명하려는 실수를 해요. 문서를 작성하는 사람 입장에서 생각하기 때문이에요.
독자는 "이 기능이 왜 필요한가?", "내게 어떤 도움이 되는가?"를 먼저 알고 싶어 해요. 따라서 기능 설명보다 먼저, 이 기능이 해결하는 문제와 제공하는 가치를 먼저 전달하는 것이 중요해요.
독자는 자신이 해결하고 싶은 문제가 해결될지 궁금해하며 문서를 읽어요. 가장 먼저 이 문서를 읽으면 무엇을 얻을 수 있는지, 어떤 문제를 해결할 수 있는지를 명확하게 전달하면, 독자가 내용을 끝까지 읽을 가능성이 높아져요.
독자가 이 문서를 읽고 해결할 수 있는 문제나 독자가 기대할 수 있는 긍정적인 변화를 먼저 설명하세요.
"리버스 프록시 설정은 2019년에 도입되었고, 많은 수정이 있었습니다..."
"리버스 프록시 설정을 적용하면 네트워크 지연 문제를 최소화할 수 있어요."
기능 나열보다 이 기능이 왜 유용한지를 먼저 설명하세요. 예를 들면 "이 API는 여러 설정 옵션을 제공합니다." 보다는 "이 API를 사용하면 로그 데이터를 실시간으로 처리할 수 있습니다." 가 독자에게 더 유용해요.
"이 스니펫은 다양한 설정 옵션을 제공합니다. 먼저 connection_timeout
, retry_attempts
, max_pool_size
등의 매개변수를 수정하세요. 그런 다음, ..."
"이 스니펫을 사용하면 PostgreSQL 데이터베이스 연결 속도가 50% 빨라집니다."