개발문서 작성, 이것만은 꼭 지키자.

개발문서를 잘 작성하기 위해서는 많은 시간과 경험이 필요한게 사실이다.

하지만 그 전에 기본적으로 문서 작성에 대한 사고체계를 정립하는 과정이 필요하다.

체계적인 규칙없이 생각나는대로 메모하듯 작성된 문서는 내용의 일관성이 떨어지고,

누구도 알아보기 힘들며, 문서의 신뢰성을 의심받을 것이다.

아래의 내용들을 염두에 두고 개발문서를 작성한다면 개인이 참고하기 위해 작성하는 메모 수준에서

벗어나 타인에게 유익한 정보를 제공하는 문서로써의 가치를 충분히 가질 수 있다. 

• 문서 작성 목적을 확실하게 인지한다.
• 주체를 확실하게 거론한다(두 개 이상의 주체는 지양).
• 사실과 의견을 확실히 구분한다.
• 주제는 직설적으로 전달해야 한다(~수도 있다는 추측성 표현은 지양).
• 반드시 필요한 내용만 작성한다.
• 상황에 맞는 올바른 조사를 사용한다.
• 같은 조사의 중복 나열은 지양한다.
• 가급적 쉬운 표현을 쓴다.
• 하나의 문장에는 하나의 논리만 표함시킨다.
• 맞춤법은 문서 신뢰도와 직결됨을 유념한다.
• 독자 눈높이에 맞추도록 노력한다(독자대상 파악이 필수).
• 필요 시 그림이나 표를 삽입해 집중도와 시각화를 동시에 만족시킨다. 

"사람에게는 스토리가 매우 중요한 요소입니다.

그리고, 그 스토리를 전개함에 있어서 양념도 잊지 말아야 합니다.

글쓴이는 글을 읽어나갈 동기를 명확히 부여해주고, 주의를 끌며,

갈등의 고조와 해소와 같은 굴곡과 호기심을 유발할 수 있는 요소들을

곳곳에 심어둬야 합니다. 그리고 무엇보다 독자를 폄하하는 수준이 아닌

독자들이 쉽게 이해할 수 있는 글을 써야 합니다.

또한 독자는 알지 못한다는 전제로 쉽게 쓰며 전문용어를 남발해서는

안 됩니다."

 - 《조엘 온 소프트웨어》의 저자 조엘 스폴스키