ドキュメンテーションのみ行う
💪やること
JIGのソース(情報源)となるのはコード(テキスト、バイナリ)のみ。
ドキュメントからコード生成やコードの編集などはしない。
🚩目的
コードをどまんなかに据えた開発を支援する
🤔経緯
MDD(モデル駆動開発)のような、ソースコードの自動生成ができたらいいな、と言う話をよくされる。
これを行わないことを明言する。
ダイアグラムや一覧をいじって出力されたコードはメンテナンスが難しく、通常はジェネレーションギャップパターンを用いないと厳しい。
JIGはドキュメントとソースコードを結びつけるツールだが、ソースコードからドキュメントへの一方向のみとし、ドキュメントからソースコードは一切サポートしない。
🏆結果
コードを書くことに注力できる
🔗関連