拙い設計には見辛いドキュメントを
🚩目的
JIGは拙い設計を際立たせるツールでありたい。
ドキュメントの指針をたて、過剰に見易さのための調整を行わない。
🤔経緯
拙い設計で作られてしまっているプロダクトは存在する。
このようなプロダクトのドキュメントとして成立するよう、ドキュメント生成ツール側で調整することは不可能ではない。
しかし見易さの調整は限定的な用途に特化するからもはずれるし、拙い設計をよく見せるのではなく、直すフォースをかけたい。そのために見辛いドキュメントを出力する。 ドキュメントが見やすいと設計に妥協が生まれる。JIGの用途からは逆行する。
🏆結果
拙い設計を改善する動機となる。