dcmodel 文書作成ガイドライン

はじめに

dcmodel 文書作成ガイドライン (以下, 本ガイドライン)は, 数値モデルに伴う解説文書ならびにその作成のスタイルを提案するものである.

数値モデルに伴う文章には次の三種類がある.

数理モデル解説(定式化, 支配方程式系, 境界条件, 諸パラメタ等),
離散モデル解説(数理モデルの離散化),
ソフトウェア解説(利用手引, 開発手引, ソフトウェア概説, リファレンス)

このうち, ソースコードのリファレンスマニュアルに関しては, ソースコードにコメント行として埋め込んでおくことにより, 自動生成されるように資源を作成することを念頭にするので, その具体的書法に関してはプログラミングガイドラインに記すこととし, ここではふれない.

ルールの概要

資源の作成においては, 数値モデルに関する文書における方程式系, 変数名等とソースコードで用いられる変数名や関数等の対応付に留意してこれを行う.
数値モデルに関する文書において, 基礎概念や基礎原理・技術の解説には深入りしないように留意する. 基礎の詳述は他の文章にゆだねること.