Manual creation seminar and in-house support case studies

[Case Study] Medical Imaging Diagnosis System Manual Creation and In-house Support

Customer Requests and Challenges

We received an inquiry from a company that develops software for medical institutions such as hospitals, expressing a desire to improve the "manuals" and to standardize "manual creation skills", through the Human Science website.

Traditionally, software developers were responsible for creating manuals, but three years ago, we established a dedicated team of three members for manual creation, and we have been producing them in-house.

However, you were facing challenges such as "the manuals are difficult to understand," "I don't know what to fix and how," and "the skills of the staff are inconsistent."

Therefore, on the Human Science website, please take a look at 'Your Manual Will Change! 6 Innovations http://www.science.co.jp/document/special.html" and feel that there are commonalities with the direction your manual aims for, leading to your inquiry through the website.

5 STEP Proposal

After receiving your inquiry and going through several meetings, we proposed the following processes aimed at achieving "Review of Manuals""Skill Enhancement for Manual Creators
""Standardization of In-house Manual Production".

STEP1 Hearing

In manual creation, the first key point to grasp is the "purpose of the manual".

We first inquired about the basic matters such as the purpose of the manual, the "target users," and the "user's manual usage situations" to confirm whether the current manual is suitable for its intended use and to establish the "direction to aim for" that fulfills the "purpose of the manual".

In addition, we heard about how Human Science can support our current customers in-house manual production, including the "manual creation and operation system within the customer's company" and the "issues recognized by the customer."

STEP2 Manual Analysis

After conducting a hearing in STEP 1, we received the current manual and performed analysis and evaluation.

　　

Manual Analysis Evaluation (Click to Enlarge)

While our clients have made efforts and the text itself is not significantly problematic, we have suggested refining the way the table of contents and headings are structured and designed to improve the ease of finding information and readability.

Setting Improvement Goals

STEP 3 Seminar

Based on the curriculum, methods to improve the issues of the current manual will be evaluated in STEP2.

The first seminar was held in December 2013.

1st Manual Creation Seminar

Before the seminar, not only the evaluation of the current manuals but also to measure individual skills, a "Skill Assessment Check Test" will be conducted.

The purpose is to identify key topics to be covered in the seminar by analyzing the manuals created by our clients and conducting skill assessment checks, thereby enhancing the effectiveness of the seminar.

By incorporating lectures, exercises, and discussions, this training is designed to be participatory, allowing participants to enhance their knowledge and skills through "thinking, writing, and speaking".

　　　　

Skill Check Evaluation Report and Seminar Curriculum (Click to Enlarge)

STEP 4 Design/Creation

After the manual creation seminar, we move on to the actual "improving the manual" and "enhancing the customer's creation skills" phase.

To achieve these two objectives, we propose a process for collaborative writing of a single manual.

By having the customer write Chapters 1 to 2, and Human Science perform proofreading checks, and then having Human Science write Chapters 3 to 4 while the customer conducts proofreading checks, it is possible to apply the writing know-how learned in the seminar to actual production.

Regarding manual design, the DTP designer from Human Science has revamped the Word-based design.

Of course, we considered not only "readability" and "appearance," but also the "ease of updating" for our clients when creating new templates for collaborative writing.

STEP5 Standardization Operation and Maintenance

Even after creating one manual, the release of other product manuals will continue.

We have created standardization guidelines to maintain the quality of manuals continuously.

Writing Guidelines

We have extracted expressions and terms that should be standardized and created our own writing guidelines for characters and terminology.

By having multiple writers, we can prevent inconsistencies in expressions and terminology during revisions, ensuring uniform quality.

Design Template

We have prepared Word templates that you can update yourself.

Styled chapter titles, section titles, subheadings, and operation procedures, and configured quick parts.

We continuously improve our templates to make them user-friendly, incorporating feedback from our customers.

Schedule from STEP 1 to STEP 5

Customer Feedback

Before starting the transaction, we consulted several manual creation companies,

- It seems easy to communicate closely and consult.

- A concrete roadmap towards the goals of manual improvement and skill enhancement

- The image of how much better the manual will become is the clearest

For this reason, we have decided on Human Science.

Until now, we had been creating manuals through trial and error, but after co-authoring the manuals during the seminar, not only were the manuals improved, but we also understood the "ideal form" of the manuals, and we were able to "enhance our own skills as well.

Whether it's seminars or manual creation, the charm of Human Science lies in the fact that they always conduct a review instead of leaving things "as is" to ensure that skills are being retained and to follow up on any areas that need improvement.

The development department has also received positive feedback, stating that 'the manual has become easier to read and understand.'

Related Services

Manual Creation

In-house Manual Support

Manual Improvement