Laserfiche WebLink
Mosaic <br />Ultimately, the documentation for the CRDSS will reside on one machine which will be <br />accessed via the Internet and therefore documentation will not need to be distributed to each <br />Mosaic <br />machine. However, the server machine may not be the archive machine at RTi and in fact <br />Mosaic <br />will most likely be the Briefing Room machine. Distribution of CRDSS documentation may <br />Mosaic <br />be implemented in the long term in order to provide two or more backup hosts to act as <br />Mosaic <br />servers. Documentation may also be distributed to a limited extent to PC users since runs <br />under Microsoft Windows. Consequently, the discussion above is still applicable in this case. <br />Mosaic <br /> documentation for each software product should be written by the developer of the software <br />and should be stored under revision control in a ?doc? directory under the software main directory. <br />In order to provide a standard framework for such documentation, all HTML files should have the <br />extension ?.htm?, all GIF files should have the extension ?.gif?,, and all text files should have the <br />extension ?.txt?,. Filenames should be kept to eight characters plus a three character extension (8.3) <br />so that the documentation can be ported to a PC. <br />Mosaic <br />The directory structure and complexity of hypertext links employed for the documentation <br />for a software product are left to the discretion of the software developer with the caveat that the <br />documentation organization will be reviewed by RTi. Migration of existing documentation into <br />HTML format will be accomplished using available programs from public domain sources (e.g., the <br />wp2x <br /> program) and by using procedures developed by the project team. These procedures will be <br />further documented as they are implemented for the project. <br />The development of documentation that is applicable in a general sense will be coordinated by RTi <br />Mosaic <br />for use by all project team members. This includes development of a glossary, and the link <br />Mosaic <br />to UNIX man pages. The general structure of on-line documentation for the CRDSS is <br />shown in Figure 1. <br />CRDSS Home Page <br />2 Min SumOverviewScenariosManuals ProjectMan pages <br />Tasks Flow ChartsMODSIM Programs <br />Team CU Model Libraries <br />AOP <br />CRSM <br />Glossary <br />DB <br />Figure 1. Basic organization of CRDSS on-line documentation <br />5 <br />A275 06.29.94 1.05-12 Malers <br />