Difference between revisions of "Documenting Customisations"

Revision as of 20:04, 22 April 2013

Document Workflows and Business Rules

After the desired data elements and field report templates are customised and published, the next step is to define and document the information workflow for each type of field report. This is a critical step for ensuring the quality of the data stored in IMSMA^NG. It involves combining the workflow rules identified in Chapter 1 with the field report templates defined in Chapter 2 to create a set of workflows that can be documented as instructions or SOPs for entering and reconciling data in IMSMA^NG. Each workflow and SOP should include rules for:

• assigning locations
• updating and replacing items
• linking items

With these rules defined, information managers can help improve data consistency and ease of searching and reporting while reducing data entry errors and the effort to correct them later. Information managers can also develop data quality searches and reports that identify and enforce the information workflows. The diagram below identifies a basic information workflow, but information managers should provide guidance to data entry personnel for how the workflow should proceed in their programmes.

Creating a Programme Specific User Guide

Creating a programme-specific user guide is a critical step in communicating information management concepts and decisions to IMSMA^NG users, particularly because IMSMA^NG is so customisable. With a programme-specific user guide information managers can:

• ensure faster training of information management and operations staff
• reduce the likelihood and impact of data quality problems
• provide an easy reference for data entry personnel and users of IMSMA^NG information

The following sections provide guidance on creating a programme-specific user guide that supplements the IMSMA^NG User Guide with specialised steps for how information should be managed within the programme.

Content to Include

The guide should document the programme-specific customisations of IMSMA^NG as discussed in Chapter 1 and Chapter 2 of this manual. It should provide straightforward, task-specific guidance and avoid complicated discussions of possible options and conditions. Ideally, the guide is an intermediate document that bridges the gap between the goals, objectives and terms of reference of information management and the specific “how-to” instructions in the IMSMA^NG User Guide.

Overview

The Overview section should cover basic information about the guide, its purpose and intent and about information management responsibilities. It should describe the overall workings of IMSMA^NG including the configuration of the IMSMA^NG system within the programme as well as the number of users and basic roles and responsibilities.

Items and Processes

In this section, information managers should define each item and process that will be tracked in IMSMA^NG. Following the recommendations in XXX, this information should include:

• description of each item category and subcategory that will be used (see Items)
• definition of what each item category and subcategory will be used for (see Items)
• list of key data elements including custom-defined fields (see Items)
• description of the relationships among items (see Assigning and Linking)
• list of the status values for each item (see Status Changes)
• direction for how locations will be used (see Location)
• description for how tasking will be used (see Tasking Tool)

Workflow and Business Rules

This section should define the workflows and business rules that are to be followed when collecting and updating hazard and hazard reduction information. Workflows identify the processes (hazard reductions) undertaken on a hazard and the resulting status changes, from identification to clearance and completion. Include a workflow for each different kind of hazard in use

Data Entry Process and Guidelines

When the relevant items, processes and workflows are identified and documented, information managers should provide guidelines to assist data entry personnel in correctly entering, reconciling and linking data according to the processes. The guidelines should include an entry for each of the field report templates to be used and a description for how each should be entered. At a minimum, these guidelines should include:

• name and description for each field report template
• list of required fields and what the values should be
• definition of how the items in the field report should be reconciled (as new or as updates)
• description of how to determine the location for each item in the form if it is new
• definition of which existing items should be linked to the items in the field report

Outline to Follow

Below is an outline of a programme-specific user guide with suggestions for content to include in each section.

1. Overview
2. Items and Processes
1. Locations
2. Hazards
1. Suspected hazardous areas (SHA)
2. Confirmed hazardous areas (CHA)
3. Minefields
4. UXO spots
3. Hazard reductions
1. Technical surveys
2. Clearances
3. Progress reports
4. Completion reports
4. Education activities
5. Quality management
1. Quality assurance reports
2. Quality management reports
6. Accidents and victims
1. Demining accidents
2. Mine accidents
3. Civilian victims
4. Demining victims
7. Auxiliary data
1. Places
2. Organisations
3. Ordnance
3. Workflow and business rules
1. CHA/minefield clearance workflow
2. Spot UXO clearance workflow
4. Data entry guide
1. Entering a new minefield form
2. Entering a minefield update form
3. Entering a hazard status change form
4. Entering a new clearance form
5. Entering progress reports

Template:NavBox Getting started with IMSMA