Manual improvement examples

[Case Study] Machine Tool CAD/CAM Software Manual Creation to Translation, Writer Dispatch

• "The manual is difficult to understand. However, I don't know what to do or how to do it."
• "I want to reduce the burden of creating internal manuals"
• I would like to request the dispatch of a manual creation writer.

 

Do you have any concerns such as these?

 

Upon consultation with a domestic machine tool manufacturer that specializes in machining centers and other products regarding a training manual for their CAD/CAM software, we would like to introduce a case where we provide a one-stop service that includes dispatching writers, improving and creating manuals, and also translation.

 

Customer Requests and Challenges

1. We want to secure time that employees can dedicate to their core tasks.

2. I want to improve the quality of the manual. I would like expert advice.

 

The inquiry to the website was made by the representative of the maintenance and sales team responsible for training and support for customers who purchased CAD/CAM software.

All manuals except for translations are created in-house.

During the sales period, it was a challenge that the time for our core business decreased due to support and inquiry responses.

The manuals have a volume of 3,000 to 4,000 pages in Japanese, English, Chinese, and German, depending on the product group.

 

Additionally, when compared to the instruction manuals of other companies in the same industry, I felt that it lacked a sense of luxury and craftsmanship.

 

Therefore, during the process of considering a complete overhaul of the training materials, online help, and user manuals, we were looking into outsourcing manual creation and dispatching writers.

1. We want to secure time that employees can dedicate to their core tasks.

During five visits over the course of one month, we delved into the challenges faced by our clients and first proposed the dispatch of production directors/writers.

 

Benefit 1 Dispatch of Production Directors/Writers → Customers can focus on their core business

The primary duties of the manual person in charge are

 

• Support during Product Implementation
• Product Seminars
• Operation and Maintenance

 

Supporting customers who have purchased products, among other things, is our primary business.

To allow you to focus on your core business, our Human Science production staff will be stationed at your site to work on your behalf.

 

• Specification information collection from the product development team
• Manual Writing
• Translation Arrangement
• Schedule Management

 

One-stop comprehensive management from Japanese content creation to translation coordination into English and other languages.

We have reduced the burden on our customers.

 

 

Benefit 2: Dispatching staff who are well-versed in manual creation know-how → Less burden on training

Unlike general staffing, professionals in manual creation are stationed here.

Our on-site staff are full-time employees of Human Science with over 10 years of experience in manual creation.

We will promptly respond to your questions and uncertainties, while being on-site, and provide suggestions for improving the manuals themselves and enhancing processes.

We can provide direction that takes into account the circumstances of our clients.

Example of Temporary Staff

12 years of experience (Translation coordinator (8 years), Technical writer (4 years))

Production experience (example)

・Document Management Server Operation Manual
・Home Appliance User Manual
・Wind Turbine User Manual
・Measuring Instrument Operation Manual (8 Language Translation)
・Multifunction Printer Online Manual (16 Language Translation)
※Trados Certified Advanced Qualification

>> Manual Creation Director, Writer Dispatch Details

2. I want to improve the quality of the manual. I would like expert advice.

In parallel with the proposal for director/writer dispatch, analyze and evaluate the current manuals.

We presented improvement proposals and samples, and proceeded with the review of the Japanese manual.

Completely overhaul the current manual

The framework for the proposal consists of the following three points.

• Comprehensive Review of Table of Contents Structure
• Complete Rewrite of Japanese Text
• Complete redesign of layout

Specifically, we analyzed and reported on the points listed below, and provided samples as improvement proposals.

• There are screen captures with a weak justification for existence. It is necessary to clarify the purpose of publication.
• The title and lead text do not convey the content.
  It is necessary to clarify the purpose, such as "What chapter is being explained" and "What the user should do".

Japanese Manual Evaluation Report Sample

English and Multilingual Manual Evaluation Report Sample

>> Manual Analysis and Improvement Proposal Details

Related Services

Manual Creation

In-house Manual Support

Manual Improvement