|
- Overview
 |
 |
 |
 |
 |
 |
|
Documentation:
Writing technical and business documentation requires professional expertise. Writers must:
- analyse the audience,
- understand the subject matter,
- interview a variety of people,
- determine the appropriate medium,
- design the content, and
- produce it in a way that suits the audience.
All this must be done quickly and accurately. Mistakes cost time and money.
|
|
|
 |
|
Trained:
ECG invests heavily in training our writers and consultants to be efficient, accurate and fast before they visit your site.
|
|
|
 |
|
Experienced:
We at ECG are experienced in analyzing your requirements and producing both paper-based and on-line documentation.
|
|
|
 |
Strategy:
ECG consultants are experienced in analyzing your documentation requirements to produce a strategy that ensures that your documentation is:
- relevant,
- accurate,
- up to date,
- easy to understand, and
- produced in the most appropriate medium.
|
|
|
 |
|
Paper-Based:
While the trend today is to move all documentation on-line, paper-based documentation is still appropriate in a variety of situations.
ECG produces quality paper-based solutions, including
- Software User Guides,
- Style Guides,
- ISO 9000 Manuals,
- Equipment User Guides,
- Policy Manuals,
- Methods and Procedures Manuals,
- Use Case Analysis Documents,
- Quick Reference Guides,
- Training Materials,
- Process Documentation, and
- Desk Instructions.
|
|
|
 |
|
- Improvement
 |
 |
 |
 |
 |
 |
 |
 |
|
|
Current Documentation:
Some of the problems you may be experiencing with your current documents:
- Is your current documentation sitting on shelves not being read?
- Is important detail hard to locate?
- Are your people constantly asking how things are done?
- Are major ideas buried?
- Are subheadings ambiguous?
- Are instructions, directions and action items difficult to find or not included at all?
- Is your documentation out of date and hard to update?
- Are there pieces missing?
- Are there inconsistencies?
- Is relevant data not where you want it?
|
|
|
 |
|
|
Our Documents:
ECG can solve all these problems for you. Our documents:
- are easy to read and understand,
- are intended to be used,
- make it easy to find the key information,
- all relevant subject matter is present,
- easily maintained and updated,
- logical and visible organization to facilitate scanning,
- are reader based and not writer based,
- relevant information can be easily retrieved.
|
|
|
 |
|
|
|
Benefits:
Research has shown that some of the performance benefits you will see:
Increases...
|
Decreases...
|
clarity of writing
|
reading time
|
reader productivity
|
training time by
|
use of documents
|
performance error rates
|
accuracy of retrieval
|
questions to supervisors
|
improved learning
|
number of words in documents
|
|
|
|
|
 |
|
Types of Documents:
ECG answers all your documentation requirements. We can produce any type of document your organization may require, including:
- training materials,
- user guides,
- procedure manuals,
- systems documentation,
- reference manuals,
- ISO9000 documents,
- operator instructions,
|
|
|
 |
|
|
- Conventional Version
- ECG Version
 |
 |
 |
 |
 |
 |
 |
|
ECG Version: This version of the audit instructions is formatted by ECG. It is very easy to
read and relevant information is quickly found.
|
|
|
 |
|
How To Prepare Data for an Audit:
|
|
|
 |
|
Introduction
One of the the most important procedures in an audit is preparing the data. Careful preparation ensures that the data is correct and that
each step of the audit has been completed.
|
|
|
 |
|
Procedure:
Follow the steps below to prepare the data for the audit
Step
|
Action
|
1
|
For data items selected for audit, obtain the following:
- Source document and
- Run data from the computer room
|
2
|
Verify the source documents sample by comparing the samples to the original list.
|
3
|
Record on a worksheet sufficient descriptive information to provide accurate identification for future audits.
Minimum Information Required
|
Examples
|
Attributes of the sample
|
- Sales Territory
- Effective data
|
Description of each data item
|
- Account Name
- Account Number
- Type of Business
|
|
4
|
Compare data samples to related documents and record on the worksheet any source of error or difference
Compare ...
|
To ...
|
Sample data
|
- Programming instructions in effect when source document begun
- Company requests
- Statistical guidelines
|
Source Data
|
Run data printouts
|
|
5
|
Prepare a summary sheet that
- Lists each difference or error found, and
- Analyzes each data item to compute accuracy ratios for the audit sample data items.
|
|
|
|
 |
|
Final Step:
Prepare to discuss your findings with company management. Be specific in both your report and the discussions.
Note: These discussions are important to
- Point out errors and difficulties, and
- Provide management with information to correct the errors.
|
|
|
 |
|
- Examples
 |
 |
|
Examples:
Below are some before and after examples.
|
|
|