Promoting the creation and operation of user-friendly manuals as a case study for improving technical manuals for engineers.

Mitsubishi Heavy Industries, Ltd.

Manual Creation
Translation

Promoting the creation and operation of user-friendly manuals as a case study for improving technical manuals for engineers.

Mitsubishi Heavy Industries, Ltd. Overview

・Established:1950

・Capital: 265.6 billion yen

・Number of Employees: Consolidated 77,430 individuals, Non-consolidated 22,233 individuals

(As of December 2022)

・Business Contents: Thermal Power Generation System Business

 

 Services

Manual In-house Support

- Evaluation

- Manual Creation Seminar

- User Survey

- Standardization Rule Supervision

- New Template Introduction (FrameMaker Design, Migration)

Translation

- Japanese to English / English to Spanish

- Glossary Maintenance

- Translation Memory Maintenance Seminar

Video Manual Creation

 

Background

"I want to create a user-friendly manual."

 

Mitsubishi Heavy Industries, Ltd. is a company that leads cutting-edge manufacturing in various fields such as energy, industrial machinery, and plants.

We are globally expanding our solutions for improving the operation of thermal power plants using the latest digital technology, as well as developing the world's most efficient thermal power generation equipment.

 

Mitsubishi Heavy Industries, Ltd. manufactures an in-house control device called "DIASYS".

The types of manuals used by users and technicians at installation sites such as plants and power plants vary widely, including software, hardware, and specification manuals. The volume also ranges from 30 pages to 600 pages per book.

 

※DIASYS (Digital Intelligent Automation System) is a Tokyo-based technical writing and translation company.

This is a distributed control system (DCS) developed to maximize the performance of plants and achieve high reliability and operating rates.

http://www.mhps.com/jp/products/control-systems/outline/index.html

 

 

Challenges before implementation

"I'm not sure how to improve the manual."

 

I have been feeling the following challenges in terms of usability of technical manuals for engineers.


"There are many requests from our clients and within our company to improve the usability of the manual."

"The manual is too large, making it difficult to find the necessary information."

"Various expressions and terms are used, making it difficult to read."

"Not only Japanese manuals, but also want to efficiently proceed with production in English and Spanish."

 

In order to improve usability and make better manuals, Human Science has been asked to provide a specific service proposal for the "Manual Evaluation" service to clarify the challenges.

 

Reasons for Choosing Human Science

Comprehensive measures and abundant achievements such as manual evaluation, user surveys, and manual production seminars.

 

The theme that the customer was feeling challenged by was


①Improving current manual quality

Inherit and revise the improved manual quality.

is.

 

"① Improve current manual quality"

Towards achieving this goal

"What are the current challenges in the manual?"

"How can we improve?"

We proposed "manual evaluation" to clarify it.

 

We also proposed "conducting user surveys" in order to demonstrate the need for manual improvement with specific numerical values based on user feedback.

 

On the other hand, in order to achieve the goal of inheriting and revising the improved manual quality,

- To improve the skills of manual creators at the "Manual Creation Seminar"

- Standardization measures that continue to improve quality even when revising through "template creation" and "guideline creation"

We have proposed.

 

We were selected for our optimal approach to quality improvement and highly valued for our extensive track record, by Human Science Co., Ltd.

 

Introduction Process

First, analyze the current situation through evaluation analysis.

Conducted manual evaluation by three evaluators in January to February 2014.

Conducted analysis and evaluation based on approximately 100 criteria. Presented a report on additional points and improvement items compared to the criteria's target points.

 

Present evidence of manual improvement

In February, a user survey will be conducted for manual users (approximately 300 people).

We surveyed user feedback from the perspectives of accuracy, clarity, searchability, and convenience.

 

Skill Up & Skill Retention at Manual Creation Seminar

Next, a manual creation seminar will be held for 9 manual creators.

To address the issues that were clarified during manual evaluation, we used the original text.

A current Technical Writer became an instructor and adopted a lecture and workshop format. This was done to improve and solidify skills.

 

Establishment of rules for implementing standardization and ensuring its adoption

In May, we supervised the standardization of manual creation rules. We adopted an efficient production method using FrameMaker and proceeded with the maintenance of templates. At the same time, we started implementing standardization measures to continue improving quality by establishing guidelines for production environment, writing expression, and layout design. We continue to operate this standardization measure even now.

 

Improved searchability and revision frequency through manual segmentation

From June to August, we implemented the subdivision of manuals. Based on user surveys, it was discovered that our two main manuals were approximately 600 pages long and had poor searchability and revision frequency. As a result, we have started dividing them into separate volumes based on functions and purposes.

 

Introduction Effect

Significant improvements have been made in terms of the clarity of the manual, the adequacy of information, and the ease of finding information.

Efficient production is possible, and cost reduction effects are also generated through manual maintenance.

Standardization measures for inheriting quality improvement have also been established and are currently being continuously implemented.

 

Evaluation of Human Science Co., Ltd.

"We started with the initial request of wanting to improve the usability of the manual, and we have been able to carry out specific improvement activities with certainty."

In addition to manual evaluation and standardization measures, we now also request translations in English and Spanish, allowing us to operate an efficient document production system.

Since 2017, we have also been working together to create video manuals for training purposes.

Manuals need to establish a system for continuous operation, not just end once they are created.

We look forward to continued support that will lead to business improvement in the future.

 

Related Services

Manual Creation and User Manual Creation

Manual Creation In-house Support Service

Manual Evaluation, Analysis, and Improvement Proposal Service

Manual Creation Seminar and Training

Localization

Video Manual Creation

 

Contact Us / Request for Materials

TOP