Laserfiche WebLink
CRDSS <br />TASK MEMORANDUM 1.17-2 <br />Model Documentation <br />Year 1 Summary <br />1.0 ISSUE <br />The CRDSS models are to have been documented according to the specifications defined in the scope of <br />work and the specifications developed during Year 1 (see Task Memoranda 1.17-1 and 1.05-12). The <br />following issues are addressed in this memorandum: <br />Have the work products defined in the scope of work been completed? <br />? <br />What decisions were made in implementing the documentation for models? <br />? <br />Do any concerns about model documentation exist for Year 2 of the project? <br />? <br />2.0 DISCUSSION/ANALYSIS <br />The work products for Task 1.17 are summarized as follows: <br />On-line Documentation <br />? <br />Context-sensitive on-line help that allows scrolling and printing <br />? <br />A standard command-line argument for each utility to print an abbreviated usage for the <br />? <br />utility <br />UNIX man pages for programs and library routines <br />? <br />Hard-copy Documentation <br />? <br />Model chapters in the CRDSS Users? Manual <br />? <br />Model chapters in the CRDSS Developers? Manual <br />? <br />Each of the work products has been completed and is discussed below. The only exception is that there <br />are no model chapters in the CRDSS Developers? Manual (although this information is available). <br />On-line Documentation <br />Mosaic <br />The program is used to document the water rights planning (WRP), consumptive use (CU), <br />annual operating plan (AOP), and Big River (BR) models in the CRDSS on-line users? manual (see Task <br />Mosaic <br />Memorandum 1.05-12), and UNIX man pages are accessed from the body of the documentation. <br />The on-line documentation is not context-sensitive in that a user cannot get a specific page of help <br />Mosaic <br />information for each screen within an application (e.g., by pressing Ctrl-H); however, the on-line <br />documentation has been written to follow the logic of model applications. Therefore, a user can display <br />Mosaic <br />the on-line documentation parallel to running a database application. Additionally, ?Help? <br />1 <br />A275 01.09.95 1.17-2 Malers <br />