Laserfiche WebLink
CRDSS <br />TASK MEMORANDUM 1.17-1 <br />Model Documentation <br />1.0 ISSUE <br />The CRDSS models will be well documented so that developers will be able to effectively <br />develop/enhance code for the models, and users will be able to effectively use the models. The <br />following issues apply to model documentation: <br />What will be the form of model documentation? <br />? <br />What software will be used to display model documentation? <br />? <br />What will be the extent of model documentation? <br />? <br />2.0 DISCUSSION/ANALYSIS <br />Supporting documents (e.g., Users' Manuals) for different models and analytical methods have been <br />collected by the RTi team. In particular, documentation for different models reviewed during Phase <br />I have been collected, including consumptive use (CU) models, MODSIM, the AOP model, CRSM, <br />and the Gunnison Model. The general state of model documentation is as follows: <br />CU Models <br />. Documentation exists primarily as hard-copy documentation from the various <br />? <br />model sources, such as the USBR. Documentation for previous work by CSU exists in <br />electronic format in FrameMaker and other document storage formats. <br />MODSIM <br />. Documentation exists in WordPerfect. <br />? <br />AOP <br />. Hard-copy documentation is available for the original USBR version from the <br />? <br />USBR. The documentation for the workstation version of the AOP model (called the 24 <br />Month Study Model) was never completed and exists in hard-copy format and FrameMaker <br />files. <br />CRSM <br />. Hard-copy documentation is available for the mainframe version and is available <br />? <br />from the USBR. <br />All GUIs <br />. In general, screen dumps of the GUIs for all of the above models can be <br />? <br />generated on the workstations and can be converted to usable formats such as GIF and <br />TIFF. <br />Mosaic <br />The program will be used to implement on-line documentation for models (see Task <br />Memorandum 1.05-12 for general implementation procedures). Documentation for models will <br />consist of overview information that describes the general capabilities and organization of models, <br />and technical information that describe the workings of the models, including a description of model <br />Mosaic <br />inputs and outputs. It is anticipated that the overview material will utilize a home page and <br />1 <br />A275 06.29.94 1.17-1 Malers <br />