Laserfiche WebLink
... <br />doc/* <br />RCS/*,v <br />In this example, the directory contains all of the utilities needed for the CRSM <br />/crdss/crss <br />model (several of the programs that are part of the CRSS are actually needed to run CRSM; hence, <br />the high-level ?crss? directory). The documentation for all of the CRSS-related applications are <br />stored in the directory and may consist of any of the documentation formats <br />/crdss/crss/doc <br />Mosaic <br />listed above. UNIX man pages and HTML files should be placed under revision control to <br />track changes to the documentation. If documentation is being converted from other electronic <br />formats (e.g., WordPerfect), then those files should be archived in the documentation directory so <br />that other forms of the documentation can be recreated if necessary. <br />The documentation directory for a software product will be maintained on the archive machine at <br />RTi. Documentation for machines such as the Briefing Room machine will be created from the <br />pman <br />archived documentation using programs such as . RTi has developed makefile rules to <br />perform operations necessary to perform some of the installation procedures and is working on the <br />remaining procedures. In particular, the organization for each software product has to be mapped so <br />that distribution of documentation can be simplified. Because all of the CRDSS software a nd data is <br />being mapped to a directory structure under the directory that is the same on all CRDSS <br />/crdss <br />machines, it will be possible to distribute documentation files that are a copy of the files on the <br />archive machine. <br />Documentation for each software product will be written by the developer that is the author of the <br />software and will be reviewed by RTi. This insures that the knowledge of the developer is <br />incorporated in the documentation and that the documentation conforms to the general standards of <br />the project. <br />3.0 CONCLUSIONS AND RECOMMENDATIONS <br />The following recommendations are made related to the issues presented in this memorandum: <br />Mosaic <br />It is recommended that be adopted as the on-line documentation system for the <br />? <br />CRDSS because of its advanced features, widespread use, and public domain nature. It is <br />recommended that UNIX man pages be used for technical summaries for programs and <br />library routines because this format is widely used, is simple to implement, and can be <br />Mosaic <br />implemented in conjunction with . <br />Documents within the Mosaic file structure will be organized using ?home pages? as the <br />? <br />entry points for major documentation products. A main CRDSS home page will be used as <br />the entry point to the CRDSS documentation. This home page will reference other <br />important home pages (e.g., ?MODSIM Manual?). The file structure under each home <br />page will use paths relative to that home page so that moving such documentation will only <br />Mosaic <br />require a change in the higher-level home page. documentation will consist of <br />HTML, GIF and text files with the extensions ?.html?, ?.gif?, and ?.txt?, respectively. The <br />Mosaic <br />extent of the documentation for each software product will be based on the extent <br />Mosaic <br />of existing documentation and the level of effort needed to create documentation. <br />Documentation for a software product will be the responsibility of the developer of that <br />product, with RTi evaluating all documentation. Documentation will be distributed by <br />12 <br />A275 06.29.94 1.05-12 Malers <br />