Macro Express at the UF Smathers Libraries

Communication Area for Macro Express Unit Developers

Monday, May 08, 2006

> A Documentation Model

As I've been trying to whip together some documentation for the Monographs Suite, I found myself whittling down more and more of the info on submacros--seeing it as redundant. So I thought I'd toss out my current working model as a springboard for discussion on some sort of standard.

REMARKS (that is, at the beginning of the script editor)
name
purpose
author
last updated
calls
variables

NOTES
description
aleph modules
macro components
calls
assumptions
activation
comments

NOTES (for submacros)
description
calls
assumptions
comments