My WebLink
|
Help
|
About
|
Sign Out
Home
Browse
Search
CRDSS_Task1_05-12_OnlineDocumentationSystem
CWCB
>
Decision Support Systems
>
DayForward
>
CRDSS_Task1_05-12_OnlineDocumentationSystem
Metadata
Thumbnails
Annotations
Entry Properties
Last modified
9/25/2011 10:18:53 AM
Creation date
5/30/2008 2:34:31 PM
Metadata
Fields
Template:
Decision Support Systems
Title
CRDSS Task 1.05-12 - System Integration Issues Documentation - On-line Documentation System
Description
This memorandum discusses methods of delivering an on-line documentation system for the CRDSS.
Decision Support - Doc Type
Task Memorandum
Date
6/29/1994
DSS Category
DMI Utilities
DSS
Colorado River
Basin
Colorado Mainstem
Contract/PO #
C153658, C153727, C153752
Grant Type
Non-Reimbursable
Bill Number
SB92-87, HB93-1273, SB94-029, HB95-1155, SB96-153, HB97-008
Prepared By
Riverside Technology inc.
There are no annotations on this page.
Document management portal powered by Laserfiche WebLink 9 © 1998-2015
Laserfiche.
All rights reserved.
/
17
PDF
Print
Pages to print
Enter page numbers and/or page ranges separated by commas. For example, 1,3,5-12.
After downloading, print the document using a PDF reader (e.g. Adobe Reader).
Show annotations
View images
View plain text
whatis <br />4.The command is executed on the CRDSS workstation to regenerate the man page <br />index to reflect additions to the system. <br />In general, all man pages should be placed under revision control so that changes in software <br />revisions results in a corresponding change in man page revisions. This is discussed further in the <br />next section. Man pages for public domain software will most likely need to be manually installed <br />on the system and should not be placed under revision control because such documents will be <br />updated by their authors. RTi will handle the distribution of such man pages. <br />Guidelines for Archiving Software Documentation <br />It is important to keep the master copy of software documentation near the source code so that the <br />source code and documentation for the product are maintainable. This may result in duplicates of the <br />documentation be present on the archive machine (one copy in the archive directory and one copy in <br />the distribution location). For example, HTML documentation for an application should be stored in <br />a subdirectory for the application but may also be stored in a documentation-only directory structure <br />Mosaic <br />that is accessible by CRDSS users (and possibly from the Internet, if a server is configured). <br />However, client workstations (machines other than the archive machine) will only have one copy of <br />the documentation. It is important that only the master copy be modified, and not the copies that are <br />distributed. <br />Source code documentation for CRDSS applications and libraries can take a number of forms: <br />existing hard-copy documentation <br />? <br />existing electronic documentation that may not be easily transferable (e.g., WordPerfect <br />? <br />documentation) <br />existing electronic documentation that is easily transferable (e.g., ASCII ? README? files) <br />? <br />UNIX man pages <br />? <br />Mosaic <br /> HTML files <br />? <br />Mosaic <br />The discussion of in this memorandum indicates the procedures used to implement on-line <br />documentation with this software and will not be repeated here. The details on implementing UNIX <br />man pages are also discussed in a previous section. <br />Each application, library, or suite of utilities developed for the CRDSS will generally have its own <br />directory. A ?doc? directory should be created under such directories to include all of the <br />documentation for the software product. Additionally, RCS should be used to place the <br />documentation under revision control (see Task Memorandum 1.05-20). For example, the <br />documentation for the CRSM software will be stored in the following directory structure: <br />/crdss/crss/crsm/* <br />RCS/*,v <br />mhydro/ <br />... <br />tapedit/ <br />11 <br />A275 06.29.94 1.05-12 Malers <br />
The URL can be used to link to this page
Your browser does not support the video tag.