Case Studies Archives - The i-Team : Technical Manuals, Handbooks, User Guides & Instructions, Training Material

The i-Team® works with CWGC to develop technical manuals and training guides

dev — Tue, 05 Nov 2024 17:05:39 +0000

The i-Team^®services used: Technical writing, project management and translations

Duration: 18 months

Deliverables: Various technical manuals, procedural documents, guides and standards

Project outcome: Improved standards across the organisation and reduced training time

The Commonwealth War Graves Commission (CWGC) is a global leader in commemoration. Founded by Royal Charter in 1917, CWGC works on behalf of the Governments of Australia, Canada, India, New Zealand, South Africa and the United Kingdom to commemorate the 1.7 million men and women from the Commonwealth who lost their lives in the two World Wars. The cemeteries, memorials, graves, landscapes, and records in CWGC care will be found at 23,000 locations and in more than 150 countries and territories. The Commonwealth War Graves Commission’s mission is to ensure those who died in service, or as a result of conflict, are commemorated so that they, and the human cost of war, are remembered for ever.

The i-Team® re-wrote the Commonwealth War Graves Commission Horticulture Manual – Revised Edition. The project involved researching various areas of horticulture, reviewing existing literature, articles, web content and blogs, as well as watching videos and lectures to identify and document best practices. As part of the project, The i-Team® identified, collected, edited and standardised content of approximately 5000 pages from 200+ sources. A new manual was created, supported with professionally created illustrations and photographs.

Final version of the manual was 1500 pages spread over a number of self-standing sections covering the following:

Soil management
Plant establishment
Ornamental features management
Tree management
Pruning
Weed management
Pest control
Headstones management
Site management
Building works
Irrigation
Operating machinery
Quality control and biosecurity procedures

An online HTML version of the manual was delivered along with training guides and other material to support a global training programme.

The i-Team® felt it was truly an honour to be chosen by CWGC from an open tender. The i-Team® produced documents are currently being used to improve global standards in the maintenance of the two war cemeteries and memorial sites to better commemorate the war heroes.

“Motia and her expert team have been amazing, providing a clear project plan, regular catch ups and excellent communication. The project was relatively complex with a mix of old and new material needing to be pulled together into a professional technical manual. The team developed and refined a superb resource for us, utilising our brand guidelines but developing an professional identity for our resources. The great benefit we found was the fact we could use The i-Team as a one stop shop, taking care of the technical authoring, graphics and illustrations and supporting us with translation services. The i-Team really is a great team to work with!”

Adam Blunt

Senior Tehnical Training Consultant

The post The i-Team® works with CWGC to develop technical manuals and training guides appeared first on The i-Team : Technical Manuals, Handbooks, User Guides & Instructions, Training Material.

The i-Team® works with the Department for Business, Energy & Industrial Strategy (BEIS).

iWJyHgZeGAk — Tue, 03 Oct 2023 09:06:13 +0000

The i-Team® works with the government department for Department for Business, Energy and Industrial Strategy (BEIS) to explore best practices in product manual writing.

The i-Team® was contracted by the Office for Product Safety and Standards (OPSS), part of the government department for Business, Energy and Industrial Strategy (BEIS) to carry out a scoping study to explore best practice in the design and writing of instruction manuals with a focus on domestic products. The study formed one part of OPSS’ Strategic Research Programme (SRP) to commission high-quality science-based research, strengthening the evidence base for the development of product safety policy and its delivery and enforcement.

Based on OPSS objective, which was to understand the quality of existing manuals explore best practices, The i-Team came up with a complete research strategy and data gathering approach that was well received by OPSS. The scoping study reviewed 25 existing product manuals across five categories: fridges and freezers, cooking appliances, dishwashers, washing machines and tumble dryers. Common industry practices and recommendations based on literature review and official standards were also explored during this study. The entire strategy was

As part of the study, a preliminary set of best practices for manual production was identified by The i-Team®. Suggestions for improving the quality of manuals, in particular the safety instructions were proposed. Finally, further research to understand consumer behaviour and the psychology behind people’s various degrees of interaction with product manuals was recommended to develop a revised set of best practices for creating more effective product manuals.

The i-Team®’s work has contributed to OPSS gaining an insight into the quality of existing product manuals, the common styles used by businesses to create manuals and consumer behaviour towards using product manuals. Our work also contributed to OPSS identifying future studies to in the field of health and safety and consumer behaviour.

Click here to read the published report.

The post The i-Team® works with the Department for Business, Energy & Industrial Strategy (BEIS). appeared first on The i-Team : Technical Manuals, Handbooks, User Guides & Instructions, Training Material.

The i-Team® works with one of world’s largest pharmaceutical companies.

iWJyHgZeGAk — Tue, 03 Oct 2023 09:05:23 +0000

The i-Team® was contracted by one of UK’s largest pharmaceutical companies to develop a series of technical documents for their new manufacturing site. This included producing the following documents:

Project Management Plan
Stakeholder Management Plan
Communication Plan
Project Execution Plan
Project Interface Management Plan
Design Management Plan
Engineering Plan
Document Control Plan
Health and Safety Plan
Emergency Response Plan

The i-Team continues to support the project and the next phase will involve documenting the product manufacturing procedures.

The post The i-Team® works with one of world’s largest pharmaceutical companies. appeared first on The i-Team : Technical Manuals, Handbooks, User Guides & Instructions, Training Material.

Standard Operating Procedures for British Sugars

dev — Mon, 02 Oct 2023 11:33:34 +0000

Content coming shortly…

The post Standard Operating Procedures for British Sugars appeared first on The i-Team : Technical Manuals, Handbooks, User Guides & Instructions, Training Material.

Manuals for commercial collators, laminators and punching machines

dev — Mon, 02 Oct 2023 11:29:14 +0000

Content coming shortly…

The post Manuals for commercial collators, laminators and punching machines appeared first on The i-Team : Technical Manuals, Handbooks, User Guides & Instructions, Training Material.

The i-Team® works with CR2 to develop to develop training material for banking software

iWJyHgZeGAk — Mon, 02 Oct 2023 09:04:31 +0000

CR2 is the leading global provider of self-service banking software solutions. CR2’s unique BankWorld solution empowers financial institutions with the ability to deliver a complete suite of integrated electronic self-service channels including ATM, Internet, Mobile, and Kiosk from a single self-service platform.

The i-Team® worked in collaboration with CR2’s technical team and subject matter experts (SMEs) to develop a total of 40 training courses covering system overview, configuration, administration and maintenance. This included classroom based instructor led courses, workshops and e-Learning modules. The courses were based on the actual BankWorld system installed on virtual machines, allowing The i-Team® to create training material that matched the system installed on CR2’s client sites.

Example of courses developed:

Overview Curriculum:

ATM System Operation Overview
Online Banking System Overview
SMS Banking System Overview

Installation and Configuration Curriculum:

ATM System Configuration
Online Banking System Configuration
SMS Banking System Configuration

Operations and Admin Curriculum:

Banking System Operation Daily and Regular Tasks
Customer Administration
System Administration and Maintenance

The training courses developed by The i-Team® play a core part in CR2’s sales and implementation process. They have systemised the process of training and reduced the time and resources required to train CR2’s customers and staff.

The post The i-Team® works with CR2 to develop to develop training material for banking software appeared first on The i-Team : Technical Manuals, Handbooks, User Guides & Instructions, Training Material.

Development of an Operating and Maintenance Manual for a suite of cleanrooms for a pharmaceutical company

dev — Sat, 19 Nov 2022 17:44:00 +0000

About the Project

Specific Environments Ltd (SEL), now part of Angstrom Technology, is a construction engineering company with over 40 years’ experience as a specialist design and installation provider for cleanrooms, containment laboratories and controlled environments.

The i-Team^® Services: Technical writing and project management

Project Duration: 8 months

Project outcome: Maintenance cost reduction and the implementation of best practices

The Challenge

For this project, SEL was tasked with designing and building a suite of cleanrooms for a major pharmaceutical company. The installation consisted of two new cleanrooms, constructed inside an existing building, with air handling units, ductwork and a BMS control system. The project also included the construction of all floors, walls and ceilings; electrical and lighting installation; cold water systems and drainage; and airlock doors.

SEL was unsure of how to bring together and systemise all the relevant technical documentation so that the information is easy to find and use. The source files covering a wide ran

ge of systems, tools and procedures were also in different styles and formats with little consistency between them.

The Solution

The i-Team^® was responsible for gathering together all the SEL and third-party installation, maintenance and operating instructions, schedules of equipment, and engineering and electrical diagrams. This information, along with a detailed description of the installation, was incorporated into a single operating and maintenance manual.

The i-Team^® developed a documentation standard as well as template to standardise the various technical documents. Information was transferred over to the new templates and then edited and standardised carefully following the new standard. Content was carefully edited and presented so that users can easily find the information they need. Cross reference links were built throughout the final manual for ease of navigation. The project required liaison with multiple suppliers, stakeholders and subject matter experts.

The i-Team^® managed and delivered the project based on the themes, principles and processes of PRINCE2. A detailed project plan was created at the start of the project which ensured smooth transition from one stage of the project to another and the timely completion of the manual, as well as a smooth sign off and handover process.

The Deliverables

The final suite of documentation consisted of over ten thousand pages, incorporating numerous product manuals, guides and schedules. The documentation was supplied in the form of PDFs. Editable versions were also supplied for maintenance by SEL.

The main operating and maintenance manual written by The i-Team^® contained:

Overview of the project
Contractual and legal information
Health and safety information
System descriptions
Schedule of plant and equipment
Details of commissioning and testing
Operating procedures
Maintenance procedures
Schedule of recommended spares
Additional manufacturers’ literature
Record drawings
Document maintenance procedures

Outcome

On completion of the project, the manual was handed over to the client to be used for the future maintenance of the cleanrooms. This has resulted in the reduction of maintenance cost and the implementation of best practices for efficiently maintaining the cleanrooms.

“Working with The i-Team® has proven to be a real pleasure. Their Technical writing personnel accurately and efficiently supported our company in producing necessary documentation for our demanding pharmaceutical clients.”

James Cossar

Operations Director

The post Development of an Operating and Maintenance Manual for a suite of cleanrooms for a pharmaceutical company appeared first on The i-Team : Technical Manuals, Handbooks, User Guides & Instructions, Training Material.