compass

ドキュメント

created : / updated :

ドキュメントに書くこと

ドキュメントは「なぜつくったのか」「何を実現しているのか」「どう使えるのか」についての記述を含んでいなければならない。

初見者に対していきなり内部実装の説明をもってくるべきではない。


参考文献