Sources for model documentation standards

[Rogelio Oliva]

Roy,

I developed a utility to generate a web-savvy model documentation of
Vensim models. The model documentation is very similar to what
DYNAMO model documentation used to generate:

Equation
Units
Description
Description of all inputs to the equation

With the advantage that every occurrence of a variable names is a
link to the equation that describes it, thus facilitating the
navigation of the model documentation.

The following URLs lead to two examples of documentation of published
models -- follow links to download technical documentation of the
model (html):

http://www.people.hbs.edu
oliva
esearch/service/esq.html
http://www.people.hbs.edu
oliva
esearch/dotcom/

The utility is available at http://www.people.hbs.edu
oliva
esearch/sd/


Rogelio Oliva

---
Rogelio Oliva
Assistant Professor
Harvard Business School, Morgan Hall T87, Boston, MA 02163
Ph 617-495-5049 Fx 617-496-5265 e-mail roliva@hbs.edu

[Roy Greenhalgh]

Colleagues

Having just finished re-reading John Stermans acceptance speech at last
years SDS conference, he reminds us of the importance of not just
adequate, but good documentation of a model.

Can anyone point me to good descriptions of such documentation?

Thanks

Roy Greenhalgh
From: Roy Greenhalgh <rgreenh@attglobal.net>