예시를 제공하라

구체적인 예시 하나가 한 단락의 설명만큼 값지다. 출력이 특정 형태이길 원한다면, 그 형태를 보여줘라. 이것이 모호함을 없애는 가장 빠른 방법이다.

Format the data nicely.

Transform this array of users into a summary object.

Input:
  [{ name: "Ann", role: "admin" }, { name: "Bo", role: "user" }]

Desired output:
  { total: 2, byRole: { admin: ["Ann"], user: ["Bo"] } }

Write the transform function and a test matching this example.

예시는 말만으로는 흐릿하게 남는 명명, 구조, 대소문자를 못 박는다. 가능하다면 예시를 테스트로 포함하라 — 그러면 "테스트를 통과시켜줘"가 모호하지 않은 지시가 된다. 이 요령은 일반화된다: 샘플 API 응답은 파서를 못 박고, 전/후 한 쌍은 리팩터링을 못 박고, 스크린샷이나 ASCII 스케치는 레이아웃을 못 박는다. 어떤 형태에 대한 긴 설명을 쓰고 있는 자신을 발견할 때마다, 멈추고 그 형태의 한 사례를 대신 보여줘라.