Laserfiche WebLink
CRDSS <br />TASK MEMORANDUM 1.16-2 <br />Database Documentation <br />Year 1 Summary <br />1.0 ISSUE <br />The CRDSS database is to have been documented according to the specifications defined in the scope of <br />work and the specifications developed during Year 1 (see Task Memoranda 1.16-1 and 1.05-12). The <br />following issues are addressed in this memorandum: <br />Have the work products defined in the scope of work been completed? <br />? <br />What decisions were made in implementing the database documentation? <br />? <br />Do any concerns about database documentation exist for Year 2 of the project? <br />? <br />2.0 DISCUSSION/ANALYSIS <br />The work products for Task 1.16 are summarized as follows: <br />On-Lne Documentation <br />? <br />? Context-sensitive on-line help that allows scrolling and printing <br />? A standard command-line argument for each utility to print an abbreviated usage for the <br />utility <br />? UNIX man pages for utility programs and library routines <br />Hard-Copy Documentation <br />? <br />? Database chapter in the CRDSS Users? Manual <br />? Database chapter in the CRDSS Developers? Manual <br />Each of the work products has been completed and is discussed below. <br />On-Line Documentation <br />Mosaic <br />The program is used to document database utilities in the CRDSS on-line users? manual (see <br />Task Memorandum 1.05-12), and UNIX man pages are accessed from the body of the Mosaic <br />documentation. The on-line documentation is not context-sensitive in that a user cannot get a specific <br />page of help information for each screen within an application (e.g., by pressing Ctrl-H); however, the <br />Mosaic <br /> on-line documentation has been written to follow the logic of database applications. Therefore, <br />Mosaic Mosaic <br />a user can display the on-line documentation parallel to running a database application. <br />allows the on-line documentation to be scrolled and printed. <br />1 <br />A275 01.09.95 1.16-2 Malers, Rohlfs <br />