간단 설명 스킬 (Simple Explanation Skill, SES)
답을 먼저, 평범한 말로 제시하십시오. 독자가 건너뛸 수 있는 깊이 층을 추가하십시오. 단순화를 위해 진실을 희생하지 마십시오.
구조: 답 → 작동 원리 → 세부 사항
설명은 독자가 필요한 순서대로 구성하되, 자신이 배운 순서를 따르지 마십시오:
- 답. 질문에 직접 답하거나 요점을 진술하는 한두 문장. 여기서 멈추는 독자는 올바른 그림을 가지게 됩니다 — 작지만 절대 틀리지 않은 그림입니다.
- 어떻게 그리고 왜. 답 뒤에 숨은 작동 원리: 원인, 구조, 적용되는 규칙.
- 세부 사항. 숫자, 매개변수, 경계 사례, 예외, 증명. 대부분의 독자가 건너뛰는 부분 — 그러나 누군가 다시 찾아올 때 여전히 존재해야 하는 부분입니다.
다음 규칙으로 구조를 유지하십시오:
- 각 층을 완료한 후 다음 층을 시작하십시오. 요약과 세부 사항을 절대 섞지 마십시오.
- 층을 눈에 띄고 건너뛸 수 있게 만드십시오: 문단 나누기, 굵은 글씨 리드, 레이블, 제목, 또는 매체에 따라 펼침 기능.
- 답을 바꾸는 주의 사항은 답 옆에 두십시오. 안전 위험, 데이터 손실, 호환성 변경, 실제 비용은 낮은 층에 절대 두지 마십시오.
- 단계는 의존성 순서를 따릅니다. 절차 주변에 문단을 배치하십시오 — 결과와 전제 조건 먼저, 번호 매겨진 단계, 그 다음 실패 사례 — 그러나 중요도에 따라 단계를 다시 정렬하지 마십시오.
- 깊이는 질문에 따라 다릅니다. 채팅 응답은 한 층이면 충분할 수 있고, 디자인 문서는 네 층이 필요할 수 있습니다. 구조를 채우기 위해 설명을 늘리지 마십시오.
단어 선택
- 행위자와 동사로 시작하십시오: "캐시가 오래된 데이터를 반환합니다" ("오래된 데이터가 반환될 수 있습니다"가 아님).
- 한 가지에 대해 하나의 이름을 사용하고, 항상 같은 이름을 사용하십시오. 이름을 바꾸면 다른 것을 가리키는 것으로 읽힙니다.
- 짧고 흔한 단어를 선호하십시오: 사용, 시작, 돕다, 보여주다 — 활용, 개시, 촉진, 입증이 아닙니다.
- 각 문장에 하나의 아이디어를 넣으십시오. 20단어를 상한으로 삼고, 절을 쌓지 말고 나누십시오.
- 조건을 행동 앞에 두십시오: "빌드가 실패하면, lockfile을 확인하십시오" — 반대가 아닙니다.
- 용어는 독자가 만나는 지점에서 반 문장으로 정의하십시오. 배경 지식을 미리 쌓지 마십시오.
- 추상 명사를 동사로 되돌리십시오: "로그를 분석하십시오" ("로그 분석을 수행하십시오"가 아님).
- 채우기 말, 강조사, 빈 찬사를 제거하십시오: 매우, 강력한, 원활한, 포괄적인, "주목할 점은".
- 형용사 대신 숫자를 제시하십시오: "40초에서 6초로"가 "극적으로 더 빠름"보다 낫습니다.
기본: 단순하되, 절대 덜 사실이지 않음
- 모든 사실, 숫자, 경고, 주의 사항을 유지하십시오. 단순화는 세부 사항을 낮은 층으로 이동시킬 뿐, 절대 삭제하지 않습니다.
- 출처에 없는 예시, 증거 또는 자신감을 만들어내지 마십시오. 무언가를 모를 때는 솔직히 말하십시오.
- 비유를 다리로 취급하되 증명으로 취급하지 마십시오. 독자가 비유에 의존할 것 같으면, 비유가 깨지는 지점을 말하십시오.
- 단순성과 정확성이 충돌할 경우 정확성이 우선합니다 — 그런 다음 정확한 버전을 단순하게 만들기 위해 계속 노력하십시오.
예시
전: 사실이지만, 완전하고, 사용하기 어렵습니다:
트랜잭션은 하나의 분할할 수 없는 작업 단위로 처리되는 일련의 문장입니다 — 첫 번째 문장에서 암시적으로 시작되고 COMMIT 또는 ROLLBACK으로 종료됩니다 — 많은 다단계 작업이 원자적으로 실행될 때만 올바르기 때문에 중요한 구조입니다.
후: 동일한 사실을 층층이:
트랜잭션은 모두 성공하거나 모두 실패하는 문장 그룹입니다.
첫 번째 문장에서 시작하여
COMMIT(변경 사항 유지) 또는ROLLBACK(변경 사항 취소)으로 끝납니다.그룹화가 중요한 이유는 일부 작업이 전체로서만 올바르기 때문입니다: 한 계좌에서 출금하고 다른 계좌에 입금하지 않는 이체는 돈이 사라지게 만듭니다.
제공 전 확인 사항
- 첫 문장이 질문에 답합니까?
- 독자가 어느 층에서 멈추더라도 여전히 올바른 정보를 얻습니까?
- 경고와 답을 바꾸는 주의 사항이 최상위 층에 있습니까?
- 더 짧고 흔한 단어가 의미를 유지할 수 있는 곳이 있습니까?
- 모든 사실, 숫자, 주의 사항이 살아있습니까?