Title: ICIT GIS Orientation Session: Documentation for Data and Procedures: A Case Study
1ICIT GIS Orientation SessionDocumentation for
Data and Procedures A Case Study
- Presented by Rick Havel
- GIS Coordinator
- Johnson County, Iowa
- January 23, 2003
2Documentation in Relation to GIS
- Metadata (Data about Data)
- meta-data is definitional data that provides
information about or documentation of other data
managed within an application or environment. - Procedural
- Can be included in metadata
- More centered on how to then what
3Metadata in ArcGIS
- Complies with FGDC standards
- Federal Geographic Data Committee (www.fgdc.gov)
- Data describing data
- Directly appended to the data it describes
- Moves with data
- Certain elements are dynamically updated
- Collected in a consistent framework
4(No Transcript)
5(No Transcript)
6(No Transcript)
7(No Transcript)
8(No Transcript)
9(No Transcript)
10Levels Procedural Documentation(not
comprehensive)
- Task - helps users or managers complete specific
task operations. - Examples Adding a subdivision to the parcel
database, QA/QC, and changing a parcel id. - Application - helps users or managers understand
specific application activity. - Example Software installation, purpose of
software, etc. - System - documents the overall system structure
- Examples Network design, database location,
backups, etc.
11Johnson County Map Maintenace Tracking System
- Task based documentation for parcel maintenance
- Customized using ColdFusion (web customization
and database software) and SQL Server (Database
Management System) - Contains editable help documentation for managers
and users. (ActiveEdit) - Serves user based reports using Crystal Reports
Enterprise Version.
12(No Transcript)
13(No Transcript)
14(No Transcript)
15(No Transcript)
16(No Transcript)
17(No Transcript)
18(No Transcript)
19(No Transcript)
20(No Transcript)
21(No Transcript)
22(No Transcript)
23(No Transcript)
24(No Transcript)
25Dropdowns used as much as possible to reduce
input errors.
26(No Transcript)
27(No Transcript)
28(No Transcript)
29Reports! Reports! Reports!
30(No Transcript)
31Application and System Documentation
- Built using the same software as the Map
Maintenance system - Catalogs documentation for several applications,
system operations, and procedures.
32(No Transcript)
33(No Transcript)
34(No Transcript)
35(No Transcript)
36HELP DOCUMENTATION!
37Making Help Help!
- Help System Must Be
- Easy to create/update
- Easy to access
- Consistent across applications/systems
- Searchable
- Enforced as part of the workflow
38HELP!
39(No Transcript)
40(No Transcript)
41ActivEdit Software
42(No Transcript)
43(No Transcript)
44(No Transcript)
45(No Transcript)
46Closing Comments
- Each organization is different.
- Some may have the ability create a system
internally, others must outsource this type of
development. - Make your system easy to use and access,
otherwise it wont get used. - Should be universal, otherwise each group will do
their own thing.
47Thank You!
Rick Havel GIS Coordinator Johnson County
Information Services 913 S. Dubuque St. Iowa
City, Iowa 52240 phone 319-356-6080 fax
319-354-4213 rhavel_at_co.johnson.ia.us