CRDSS_Task1_17-1_ModelDocumentation

Home Browse Search

the source code for the model. HTML and UNIX man page source files will be maintained under revision control (see Task Memorandum 1.05-20). It is anticipated that documentation that is developed for new CRDSS products (e.g., database Mosaic utilities) will reside only as documentation and UNIX man pages. Such information can be viewed on-line and can be printed. 3.0 CONCLUSIONS AND RECOMMENDATIONS The following recommendations are made related to model documentation: Model documentation for each model will be available in on-line and hard-copy forms. ? On-line documentation will consist of overview information for users and technical information for developers (and interested users). Hard-copy documentation may be generated from existing documentation by using PostScript output from the original (e.g., use WordPerfect to create a PostScript output file) or will be printed from on-line documentation using standard methods available on the workstations (e.g., from within Mosaic or by using UNIX man pages). Mosaic The public domain program will provide the entry point to display on-line ? documentation for models. Overview material will be provided which will reference existing documentation that has been ported to HTML format, preformatted ASCII files, and viewable PostScript files. UNIX man pages will be used for technical documentation such as a summary of how to execute models (program names, etc.). The extent of the documentation for each model will depend on the extent of existing ? documentation and the level of effort needed to provide documentation in formats for Mosaic and UNIX man pages. It is anticipated that providing model documentation in a brief man page and/or a PostScript file created from existing documenting will not require a great deal of effort. However, implementing a full set of documentation for each model will require that cost-effective documentation conversion procedures are outlined. In some cases, this will mean that only PostScript versions of the documentation are available, rather than full hypertext versions (this applies to the MODSIM documentation). This is because some of the formatting in existing documentation (e.g., equations, figures) cannot easily be translated to other formats. The goal of all documentation efforts will initially be to provide complete content in documentation rather than concentrating on providing extensive hypertext. If deemed cost- effective, more extensive hypertext will be added to documentation. Based on RTi' initial review of documentation, it appears that MODSIM documentation will consist primarily of wp2x existing documentation dumped as PostScript or converted to HTML using the program. The CU documentation will contain preformatted ASCII material taken from existing sources but will contain hypertext HTML files developed for the CRDSS. The AOP and CRSM documentation will consist primarily of overview material. Screen dumps of the model interfaces will be incorporated into documentation where appropriate. All models will have man pages. 3 A275 06.29.94 1.17-1 Malers