Documentation Map
<< Picture ? >>
The Controls Group Documentation System uses several tools to store, configure, and link to the documentation of our systems. Our philosophy is to use the right tool for the right job and integrate these tools together to provide seemless navigation between them (which is the purpose of this website).
Integrated Content Management System (ICMS)
ICMS is the project wide repository for documents, procedures, sketches, etc. Our group uses ICMS to store the following information:
- Formal procedures requiring change control and formal approval
- Documentation on installed systems (e.g. requirements, performance specifications, block diagrams, wiring diagrams, troubleshooting guides, validation procedures, etc)
- Administrative Documentation (e.g. Group Meeting Minutes, Budget Summaries, etc)
Integrated Relational Model of Installed Systems (IRMIS)
IRMIS is a set of relational tables that is used to document the installed hardware and software. The primary tables include
- IOC table
- Component Type Table
- Installed Components Table
- PV Table
- AOI Table
- PV Usage by Client Table
Our shared folder is used to store the following items:
- Documentation on all custom component-types
- Documentation on commercial components
- Copies (identical to ICMS zips) of all deployed PLC Ladder Logic
Trac
Trac is an open-source web-based software project management and bug/issue tracking system that has been utilized to track our staff assignments and shutdown work
Wiki
We use Wiki pages to document lists, links, and brief descriptions on our web site. These and other web pages provide the primary navigation to the diverse tools.
EPICS, Tools, IOC Applications
Our EPICS source code, IOC applications, and tools are stored in cvs repositories. The latest versions can be browsed here:
