Laserfiche WebLink
documents (e.g., the water resources planning basin implementation reports), evolved from working <br />documents (containing meeting minutes, email, etc.), to engineering reports, and finally back to on-line <br />documents. Although the issues related to resolving what was required for documentation according to <br />the scope were not resolved in this task, the final implementation of the documenation was resolved. <br />Also, the initial vision for the on-line documentation was to match the hard-copy documentation from the <br />Year 1 effort (on-line documentation for Year 1 was not as expansive a deliverable as for Year 2). This <br />documentation consisted of a Users? Manual and a Developers? Manual, and appropriate items for each <br />manual were initally listed in bulleted lists on the CRDSS home page. However, in working with the <br />State management team, it became clear that the most desirable on-line documentation was that which is <br />compact and can generally fit on one screen of a web browser (with as little scrolling as possible). <br />Consequently, the on-line documentation organization was shifted to have several broad categories in the <br />home page: <br />? <br />CRDSS An Overview <br />? <br />CRDSS Database Retrieval <br />? <br />CRDSS Models Documentation <br />? <br />CRDSS Database Documentation <br />? <br />CRDSS Tools Documentation <br />? <br />Software News and User Feedback <br />? <br />Other Water Resources Home Pages <br />The Overview, Models Documentation, Database Documentation, and Tools Documentation categories <br />are broken down further (the other sections provide news or database access and are, therefore not on- <br />line documentation, per se). For example, the Models Documentation includes documentation for the <br />Water Resources Planning Model, the Consumptive Use Model, the Big River Model, and the Annual <br />Operating Plan Model. The Database Documentation includes database content, utilities, and interface <br />sections. The Tools Documentation contains documentation for CRDSS-specific tools (e.g., the Scenario <br />tstool <br />Manager and ) as well as generic utilities and development tools. Because of the decision to <br />combine the on-line Users? and Developers? manuals, the top-level documents for each major section <br />generally either consist of a summary page listing both Users? and Developers? manual sections, or the <br />Users? Manual which then references the Developers? Manual. It is assumed in this case that the primary <br />interest is in the Users? Manual, with the Developers? Manual documentation available. <br />The actual files on the system generally consist of HTML documentation under a software product (e.g., <br />/crdss/statemod/doc/html ) and the approved documentation that is visible on the web server. The <br />approved documentation exists in the /crdss/doc/online/html directory and most manual sections are in <br />the manuals subdirectory. It is the responsibility of the documentation author and documentation <br />coordination task leader to update the development documentation to the approved area. Unix man <br />pages for software are typically maintained under the doc/man directory for applications. <br />The discussion for Subtask 2 (see below) discusses some of the issues involved with maintaining one <br />master document for both the hard-copy and on-line documentation. These issues impacted how <br />documenation was updated for software and data products throughout Year 2. In general, because of <br />2 <br />a320/taskmems/ 2-12-01.doc 01/03/97 <br />