source: main/trunk/documentation/src/main/webapp/xml/html_content/about/Welcome.xml @ 25318

Last change on this file since 25318 was 25318, checked in by GarthBraithwaite_STG, 2 months ago

docs - tweaks.

File size: 7.5 KB
Line 
1<?xml version="1.0" encoding="ISO-8859-1"?>
2
3<HTML_CONTENT xmlns:ibis="http://www.ibisph.org">
4
5        <ibis:doc>
6                <name>home/Welcome</name>
7                <summary>Documentation Page</summary>
8                <description>
9                </description>
10
11                <author>Garth Braithwaite</author>
12                <company>Utah Department of Health/Software Technology Group</company>
13
14        </ibis:doc>
15
16
17        <TITLE>IBIS-PH System Documentation - Welcome</TITLE>
18
19
20        <CONTENT>
21                Welcome to the IBIS-PH System Documentation.  This page provides an overview
22                of the system documentation for the three applications that comprise the
23                IBIS-PH system (View, IBIS-Q, Data Admin).  This documentation does NOT include
24                end user documentation.  It is intended to aid system administrators, content
25                managers, application developers, and potential adopting agencies learn how
26                to install, extend, and manage the IBIS applications.  Please see the
27                <a href="#prerequisits">Reader Prerequisite Knowledge</a> section below
28                which describes the intended reader audience and the requisite knowledge
29                needed for the content contained on this site.
30
31                <div class="Error">
32                        <h2>Documentation Status:</h2>
33                        Due to limited funding, the documentation presented on this site is not
34                        complete nor has it been proofed or edited.  The View System documentation
35                        is relatively close for System Information, Installation, and Content Management
36                        other than the IBIS-Q related pages.  The appendicies are mostly accurate
37                        but not 100% proofed or complete.  The various reports listed have not
38                        been tested recently and most likely do not work.  The IBIS-Q documentation
39                        is lacking in all areas other than the content management section and
40                        Appendix A - of which neither has been proofed.  The Data Maint and Admin
41                        documentation is complete for System Information and Installation but has
42                        not been proofed.  The IBIS-PH Admin Technical Reference is an MS-Word
43                        document and is quite old but the database data element definitions are
44                        still mostly correct and accurate in this document.
45                       
46                        <div class="Note">
47                                Most of the pages within this site will report a recent edit date
48                                of say June 2022.  The pages within this site are HTML_CONTENT 
49                                XML files and were moved into the html_content folder to match
50                                current version 3 content conventions.
51                        </div>
52                </div>
53
54                <h2>Documentation Orgainization:</h2>
55                The documentation is organized into three sections which correspond to the
56                three IBIS-PH web applications (see the <a ibis:href="home/Architecture.html">Architecture</a>
57                page for a more detailed definition of each application and where it fits). 
58                Each application's section documentation is then broken down into a series
59                of high level categories.  Each category contains an introduction or overview
60                type page that describes what type of pages and information that are contained
61                within the category.  The main categories that are consistent across all
62                application documentation sections include:
63
64                <ul class="ExtraWhiteSpace">
65                        <li><h3>System Information</h3>
66                                This category contains pages that are helpful to understand the
67                                application from the 30,000 foot level like architecture, features,
68                                requirements, naming conventions, the directory structure and files
69                                descriptions.
70                        </li>
71                        <li><h3>Administration/Installation</h3>
72                                This category provides the details on how to setup and install the
73                                application, how to configure and customize it, as well as any system
74                                issue type pages.
75                        </li>
76                        <li><h3>Content Management</h3>
77                                These pages are task oriented and provide the needed information on
78                                how the "super/power user" can understand and maintain the "data" or
79                                content presented.
80                        </li>
81                </ul>
82
83                Other high level categories are typically referred to as an "Appendix". 
84                These appendices contain technical reference information.  Examples are:
85
86                <ul class="ExtraWhiteSpace">
87                        <li><h3>Implementation Reference</h3>
88                                Contains pages that describe the actual design and lower level
89                                implementation detail.  This includes topics like request flows,
90                                how errors are handled, URL parameters and what they do, etc.
91                        </li>
92                        <li><h3>Technical Reference Categories</h3>
93                                These include pages that provide detailed information like Java Docs,
94                                XSLT APIs, data file element descriptions/model pages, view related
95                                topics, special reports etc.
96                        </li>
97                </ul>
98
99                <a name="prerequisits"/>
100                <div style="font-size: 0.9em;">
101                        <h2>Audience and Reader Prerequisite Knowledge</h2>
102                        The intended audience for this documentation includes directors, program
103                        managers, web content managers, system administrators, system developers,
104                        and project managers.  This documentation does NOT include any end user
105                        documentation nor does it provide use cases or any of the Unified Process's
106                        documentation artifacts. 
107                        <br/><br/>
108
109                        The System Overview type sections provide high level general information
110                        that is applicable to all types of users like project managers, system
111                        administrators, software developers, and content managers.  The content
112                        management sections are geared toward the "super user" or "power user"
113                        who have specific knowledge about web content but does not have system
114                        developer or administration skills needed to deal with the core black
115                        box application code (Java, JSPs, Javascript, XSLTs, C, etc.).  These
116                        content manager type users do have to know about XML and the type of
117                        content contained within those elements and what those elements do.
118                        Another type of content manager user is the backend SAS data expert.
119                        These users need to know how to deal with SAS, SAS Datasets, and SAS
120                        programming in general.  They also will need to know how the IBISQ CGI
121                        application control files work and how to edit those files.
122                        <br/><br/>
123
124                        The balance of the documentation is geared toward seasoned Java web
125                        application system administrators, Java web developers, RDBMS DBAs,
126                        and to a certain degree web developers.  The intent is to provide just
127                        enough information so that this type of reader can semi understand,
128                        install, deploy, and extend the system.  If the reader does not have
129                        the perquisite Java application server, Java development, web (HTML,
130                        CSS, Javascript), XML, RDBMS/DBA skills experience/knowledge for that
131                        given topic then they will need to reference other sites/materials to
132                        learn about that technology before being able to understand the
133                        content presented on this site.
134                </div>
135
136                <div class="Note">
137                        This documentation site uses the IBIS-PH View System's transformation
138                        engine, CSS, and XSLTs.  Most documentation pages are presented as HTML
139                        pages (which are simply HTML_CONTEXT XML files transformed via the
140                        appropriate HTMLContent.xslt to produce the html page).  As such most
141                        have the typical left hand menu navigation and the ability to be formatted
142                        as a printer friendly page etc.  Other pages, like the Java API docs
143                        are true stand alone HTML pages (created independently) which means
144                        that these pages do NOT have the IBIS-PH Documentation System's
145                        navigation or look and feel.  When viewing these pages, the reader
146                        will simply have to rely on their browser's back button etc.  Finally,
147                        other parts of the system documentation are delivered as MS-Word
148                        documents, Visio diagrams etc. and will need these applications for
149                        viewing and likewise will not have navigation etc.
150                </div>
151
152        </CONTENT>
153</HTML_CONTENT>
154
Note: See TracBrowser for help on using the repository browser.