文書を書くときに気をつけること

• 対象読者を常に意識すること。
  
  →対象読者が読んでもわからないことは書かない。
• ソースを読んだだけではわからない設計思想も書くこと。
  
  →事実を書くだけでなく、その裏にあるなぜそうなったかまで書く。
• 図と説明のバランスをとること。
  
  →図ばかりでも説明ばかりでも読みにくくなる。バランスが大事。

ドキュメントを書くときに悩んでいたら隣の席のMさんが教えてくれました。
ためになるなぁ〜。