Laserfiche WebLink
Mosaic <br />buttons that are available in model interfaces are configured to call up the on-line documentation <br />for that model. Each model has its own home page within the overall on-line documentation outline. <br />Mosaic <br /> allows the on-line documentation to be scrolled and printed. <br />Models and supporting utilities each have the standard command line option , which prints a short <br />-h <br />summary of the program?s usage. The option is also available to print the program version. Note <br />-v <br />that these command line options are only implemented for programs written for the CRDSS, and some <br />public domain programs (preexisting software such as the CRSS programs) may not follow this <br />convention. <br />UNIX man pages have been implemented for all model programs and can be accessed from a UNIX shell <br />man <br />using the UNIX command. The input and output files for the WRP and CU models are also <br />Mosaic <br />documented in man pages. Many of the man pages are also accessible from the on-line <br />documentation. The model chapters of the CRDSS Users? Manual present this documentation. Minor <br />utilities that are used only once during data processing (e.g., UNIX shell scripts) are not documented <br />with man pages. Task Memoranda 1.05-11 and 1.05-12 present information on man pages as well as <br />documenting program code. <br />Hard-copy Documentation <br />Model chapters in the CRDSS Developers? Manual were not implemented because much of the <br />Mosaic <br />information for model users is presented in the on-line documentation or the CRDSS Users? <br />Manual , which contains a chapter for each of the models. Much of the technical material that explains <br />the development of model functionality and data sets is recorded in task memoranda for each modeling <br />task. The extent of this material is too large to easily present in the CRDSS Developers? Manual . Refer <br />to the task memoranda for a specific modeling task for developers? documentation on that model. <br />3.0 CONCLUSIONS AND RECOMMENDATIONS <br />The following conclusions and recommendations are made regarding documentation for the CRDSS <br />database: <br />The work products as defined in the scope of work have been completed. As explained in this <br />? <br />task memorandum, model chapters were not included in the CRDSS Developers? Manual <br />because the process of reformatting material from the on-line documentation and task <br />memoranda would be too extensive, and the chapters would then be a repetition of information <br />found elsewhere. <br />The methods used to document models work well and are cost-effective. Year 2 efforts will <br />? <br />Mosaic <br />build on the work started in Year 1, including updating the documentation, keeping <br />UNIX man pages current, and periodically updating the model chapters in the CRDSS Users? <br />Manual . Review of the documentation by a greater audience will be beneficial. <br />2 <br />A275 01.09.95 1.17-2 Malers <br />