- 명세 작성자는 개발자가 명세를 읽도록 유도할 필요가 있다.
- 명세서를 읽도록 사람을 유인하는 방법은 일반적으로 글쓰기 실력과 밀접환 관련이 있다.
규칙1: 재밌게 씁시다#
- 명세를 읽게 유도하는 규칙 1번은 즐거운 경험을 누리게 만드는 것이다.
규칙2: 명세를 쓰는 작업은 머리가 돌아가도록 코드를 쓰는 작업과 유사하다#
- 명세를 쓸 때 놓치기 쉬운 점은, 올바른 작성을 물론이거니와 이해하기 쉽도록 작성해야 한다는 점이다.
- 사람은 우선 동기부여가 되지 않으면 타인이 말하려는 내용을 이해하려 하지 않는다.
- 무언가를 해석하기 보다는 단지 순서대로 읽고 이해하기를 원한다.
- 명세를 쓸 때는, 이 문서를 소개하려는 대상층을 감안하고, 단계마다 그 사람이 무엇을 이해하길 바라는지 먼저 생각해라.
규칙3: 최대한 단순하게 작성하라#
- 가능한 가장 쉬운 언어를 사용해아 한다.
- 호흡이 긴 문장은 쪼개서 짧은 문장으로 나눈다.
- 숫자를 매기거나 글머리 표를 사용한 목록, 그림, 차트, 테이블, 또는 여백을 활용해서 읽을거리가 부드럽게 보이게 만든다.
- 실제 화면보다 명세서를 더 효과적으로 개선하는 방법은 없다.
규칙4: 여러 차례에 걸쳐 검토하고 다시 읽어라#
- 명세를 검토하고 여러 번 반복해서 읽어라.
- 쉽게 이해 되지 않는 문장을 찾으면, 다시 작성해라.
규칙5: 표준양식은 해롭다고 간주한다#
- 표준양식이 있따면, 매 기능을 위해 중요하다고 생각하는 사항을 보충하기 위해 표준양식에 수많은 절을 추가하는 작업이 하나 더 늘어난다.
comments powered by