Issue Number | 4965 |
---|---|
Summary | CDR documentation enhancement project |
Created | 2021-03-24 16:05:24 |
Issue Type | Improvement |
Submitted By | Osei-Poku, William (NIH/NCI) [C] |
Assigned To | Osei-Poku, William (NIH/NCI) [C] |
Status | Open |
Resolved | |
Resolution | |
Path | /home/bkline/backups/jira/ocecdr/issue.287500 |
Creating this ticket to track potential enhancements to the way we keep CDR documentation. Currently we do have the help pages here - https://cdr-dev.cancer.gov/cgi-bin/cdr/Help.py and in addition to that CIAT has it own documentation that we update annually. The most current versions can be found in the following CDR documents on PROD as supplementary info documents.
CDR0000764043
CDR0000764041
CDR0000799670
CDR0000764042
The CIAT documention is organized by task areas and it does include detailed documentation of procedures, processes and steps for creating and updating CDR documents as well as special instructions on how we perform certain tasks. We find this more useful than the CDR help pages so there is definitely a lot of duplications between the two sources. We rarely refer to the CDR help pages.
One advantage of the CDR help pages that we miss in the CIAT documentation is the ability to search within the entire document for specific terms. This would be a great feature to have.
We also keep other documents that are not included in this documentation like the style guides, training manuals, reports documentation and other guides.
Elapsed: 0:00:00.001611