더북(TheBook)

논쟁의 여지가 있는 주장은 사실로 뒷받침하라

기술 글의 독자에게 결론을 주입하려 들면 매서운 비판이 따를 것이다. 그 대신 그들이 스스로 판단할 수 있도록 충분한 사실을 제시하는 데 집중하라. 블로그 글에서는 이런 원칙이 어떻게 드러날까? 표 5-1에 몇 가지 예를 정리했다.

▼ 표 5-1 논쟁의 여지가 있는 주장을 사실로 뒷받침하기

그냥 이렇게 말하는 대신

이렇게 말하거나 보충 설명하라

“이 최적화가 인상적인 성능 향상을 이끌어 냈다.”

최적화 전후로 공정하게 진행된 벤치마크 테스트 결과를 공유하라.

“이 새로운 언어가 오래된 언어보다 더 직관적이다.”

두 언어의 코드 예시를 비교해서 보여 주어라.

“이 신기술은 시도해 볼 가치가 있다.”

“이 신기술을 시도해 본 경험상……”이라는 내용을 덧붙여라.

“[이것]을 하기 어렵다.”

“[이것]을 하려면 [이렇게 다양한 사항]을 함께 다루어야 한다.” 또는 “[이렇게 까다로운 세부 사항] 때문에 정말 고생했다.”라고 설명하라.

“마이그레이션은 간단하고 매끄럽다.”

필요한 단계를 자세히 설명하고 복잡성을 유발할 수 있는 모든 조건을 명시하라.

“코드에 분명 문제가 있어 보인다.”

코드에서 문제가 되는 부분을 정확히 짚고, 그 부분을 안티패턴으로 여길 수 있는 이유를 설명하라.