Laserfiche WebLink
On-line Documentation Guidelines <br />Task Memorandum 1.05-12, the CRDSS on-line documentation, and the On-line Documentation <br />Guidelines chapter of the CRDSS Developers? Manual describe how on-line documentation is <br />implemented for the CRDSS. In general, each of the programs associated with a major CRDSS <br />Mosaic <br />component (models and database) has on-line documentation, UNIX man pages, and program <br />summaries available from a command line option. <br />-h <br />Revision Control Guidelines <br />Task Memorandum 1.05-20 and the CRDSS Configuration and Maintenance chapter of the CRDSS <br />Developers? Manual discuss revision control methods used within the CRDSS. Method s based on the <br />Revision Control System (RCS) have been employed by developers within the project for source code <br />and documentation. <br />Minimum Program Feature Guidelines <br />SIT meetings were used to discuss which features should be available in every program. This includes <br />the command line option to print program usage, the command line option to print program <br />-h -v <br />Mosaic <br />version. For GUI-based programs, this includes the ability to call up the proper documentation <br />for that program, the use of a status bar, and the use of a standard File menu. <br />Portability Guidelines <br />Task Memorandum 1.05-28 addresses portability guidelines. In general, all software for the CRDSS has <br />been developed with portability in mind. However, in order to be cost-effective, some applications as <br />developed cannot be ported from a workstation to a PC without some effort. This includes the MODSIM <br />interface (built on work from an existing workstation interface) and the VDB (uses GRASS, which is not <br />available on a PC). These applications require resources that a PC cannot provide at this time; however, <br />PCs equipped with X Window System software can display the graphics as the program runs on a <br />workstation. <br />All library routines and non-graphics-based code has been written in a portable fashion where possible. <br />Overall, the implementation of portable code has been according to the scope of work. Work in later <br />years of the project in which applications may run on PCs will provide an opportunity to fully verify that <br />the code is portable. <br />Benchmarking and Validation Guidelines <br />Specific benchmarking and validation for applications has been carried out under appropriate tasks (e.g., <br />under modeling tasks). Task Memoranda 1.05-2 and 1.05-22 describe how software is evaluated using <br />the Briefing Room concept. In general, software has been evaluated by RTi personnel to the extent <br />possible before being placed on the State?s Briefing Room machine, at which time the State can evaluate <br />the software. <br />4 <br />A275 .01.09.95 1.05-32. Malers <br />