Difference between revisions of "Documenting Customisations"

Revision as of 20:44, 11 March 2015

Document Workflows and Business Rules

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

• assigning locations
• creating and updating 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

Content to Include

The guide should document the programme-specific customisations of IMSMA^NG. 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. This information should include:

• description of each item category and subcategory that will be used
• definition of what each item category and subcategory will be used for
• list of key data elements including custom-defined fields
• description of the relationships among items
• list of the status values for each item
• direction for how locations will be used
• description for how tasking will be used

Workflow and Business Rules

This section should define the workflows and business rules that are to be followed when collecting and updating land and activity information. Workflows identify the processes (activities) undertaken on a land and the resulting status changes, from identification to clearance and completion. Include a workflow for each different kind of land 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 reconciling, entering and linking data according to the processes. The guidelines should include an entry for each of the Data Entry Form 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 Data Entry Form template
• list of required fields and what the values should be
• definition of how the items in the Data Entry Form should be reconciled
• 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 Data Entry Form

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. Land
1. Suspected hazardous areas (SHA)
2. Confirmed hazardous areas (CHA)
3. Minefields
4. UXO spots
3. Activities
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. Assistance
8. Auxiliary data
1. Country Structure
2. Places
3. Organisations
4. Ordnance
5. Assistance Classifications
6. Cause Classifications
7. Needs Classifications
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 land status change form
4. Entering a new clearance form
5. Entering progress reports

Template:NavBox Getting started with IMSMA