Yamaha Corporation Group Overview
・Established: October 1897
・Capital: 28.534 billion yen
・Number of Employees：
Connected 20,175 people
・Business Contents：
Musical Instrument Business, Audio Equipment Business, Parts and Equipment Business
Services
- Manual Creation
・Translation
・Building a document editing and management system using Asciidoc and GitHub
Manual Creation Flow Implemented
We have replaced the systems and tools typically used in the production flow of regular documents with various open source software (ATOM/RedPen), as well as familiar tools in the IT field such as GitHub and SourceTree.
Demo Videos for Each Process
1. This is the procedure for editing AsciiDoc with the text editor ATOM and managing data on GitHub.
2. This is the procedure for outputting HTML and PDF using Asciidoctor-PDF from AsciiDoc.
3. This is the procedure for converting AsciiDoc to XML and translating it using Trados.
※AsciiDoc (Asciidoc) is a technical writing and translation company based in Tokyo.
One of the lightweight markup languages. It can be written in a text editor and converted to file formats such as HTML, PDF, EPUB, etc.
※GitHub is a technical writing and translation company based in Tokyo.
This is a version control tool used for software development. It is not only used for source code management, but also as a document management and sharing tool for specifications and other documents. In manual creation, it allows for change history recording and simultaneous work by multiple users. It can be used starting at $25 per month for 5 users.
Background
The Audio Business Development General Manager's Manual Production Group creates manuals for network products such as routers, switches, and wireless LAN access points.
There are two types of manuals, 300 pages each, for consumers and technicians per product, written by development engineers and released by the production group. The consumer manual is edited in FrameMaker, converted to PDF, and the technician manual is edited directly in HTML.
[Background 1] Want to solve the challenges of writing HTML directly without compromising appearance
As background to this improvement, there were requests and challenges raised by the conventional production method mentioned above, such as direct writing of HTML.
- ・I want to reduce the man-hours.
- ・I want to eliminate quality degradation due to grammar mistakes.
- ・I want to eliminate version control in places unrelated to text, such as changing indentation or tags.
- ・I want to convert not only HTML but also PDF.
The HTML manual before this initiative was conducted was on the following page.
【Goal 1】Adopt Asciidoc (lightweight markup language) to create HTML manuals
In order to proceed with this initiative, we have set our first goal to "adopt Asciidoc (lightweight markup language) and create HTML manuals."
Implemented the following two specific measures.
- ・Adopt Asciidoc for technical documentation and complete an HTML manual that actively incorporates tables and other elements.
- ・Enhance the appearance of the layout using CSS and JavaScript.
- ・As a result of implementing these, we were able to create the following page.
[Background 2] Want to solve the challenges of manual creation using traditional DTP tools
As another background, there was a desire to solve the challenges of manual creation using traditional DTP tools. The challenges were unique to the internal side of the company ordering the work, and were as follows:
- ・Usually, it is difficult for in-house members to master complex DTP tools for external production.
- ・Additional DTP work/inspection costs from external sources will be required for each minor revision.
- ・It is necessary to provide sufficient production environment on the PCs of employees within the company, as there are license fees for DTP tools and paid fonts.
- ・It is necessary to standardize the production environment of PCs, such as the version of DTP tools.
- ・Additional work is required to adjust the layout of the DTP data, which serves as the basis for paper manuals, for use in HTML manuals.
- ・Creating both PDF and HTML manuals for paper manuals usually incurs separate costs.
[Goal 2] Build a new manual creation system that aims for efficiency and cost reduction.
We have set our second goal to "build a new manual creation system that aims for efficiency and cost reduction".
We have also implemented the following two specific measures.
- ・Adopt a lightweight markup language (Asciidoc) designed for easy input with simple grammar without using regular DTP tools or website creation tools.
- ・Switching from the conventional production method (separate PDF/HTML) to one-source multi-use (automatic simultaneous generation of PDF/HTML manuals) to achieve cost reduction.
We have set the goal of "reducing costs by more than 30% from the usual production costs."
Introduction Process
After considering and proposing, we started the project in January 2018 as a trial with a technical API reference manual for engineers.
【Process 1】Adoption of Lightweight Markup Language (Asciidoc)
First of all, we have removed traditional DTP tools from the process. This was due to the difficulty of preparing the work environment and the high learning curve. Instead, we have decided to use a simple text editor and adopt a lightweight markup language (Asciidoc) with easy input and concise grammar to create manuscript data.
【Process 2】Manual Data Creation for One Source Multi-Use
We have built a system that automatically generates HTML/PDF data using data conversion converters (Asciidoctor, Asciidoctor-PDF) from manuscript data written in a lightweight markup language.
[Process 2] Strengthening Layout Design
As mentioned in one of the challenges, we did not want to compromise on the layout design (appearance). Therefore, in order to enhance the layout design of the generated HTML and PDF, we created CSS for HTML and style files (in YAML format) as templates in advance to customize the appearance, and decided to automatically apply them with a batch file.
Achievements through adoption of lightweight markup language
Achieve over 30% cost reduction
Thanks to the effects of this initiative, we were able to achieve cost reduction in some steps of the conventional production process.
The biggest advantage was that the DTP editing work became completely unnecessary. We were able to reduce the time and cost spent on DTP tool work to zero, and now we can complete the work using only a text editor and lightweight markup language.
We were able to reduce costs by more than 30% throughout the entire process.
By building an advanced document creation system with one source multi-use, we were able to achieve efficiency and cost reduction in the production process.
This time, as it was the first attempt, there were initial implementation costs that were necessary.
I believe that by using this system in the future, it will also be possible to recover the initial installation costs.
Evaluation of Human Science Co., Ltd.
Not only production, but also a company that can consult on tools and systems.
Originally, we had a relationship through translation and manuals, but the person in charge of manual production is knowledgeable and skilled in programming and system knowledge, and we recognize them as a partner who can not only produce manuals, but also exchange information on the latest technology.
AsciiDoc, GitHub discussions have led to smooth requirement design and the introduction of tools that are not yet common in the manual industry.
Since the trial has ended, we will now verify the initial goal of reducing engineer workload.
In the future, we plan to introduce access analysis using Google Tag Manager and Google Analytics, as well as app integration. We look forward to your support for our expansion.
Free Download of OSS System
We have published a simplified version of this case study's OSS system on GitHub.
This system includes features such as templates, HTML conversion, and PDF conversion, allowing you to utilize templates to create manuscripts and generate HTML and PDF files.
Open source and available for free download to anyone with a GitHub account.
https://github.com/human-science/adpy/blob/master/README-ja.adocYou can check the samples (HTML, PDF) generated using the OSS system from the adoc, html, and pdf folders.
※PDF is viewable with the following browser. Please download HTML to view.
https://github.com/human-science/adpy/blob/master/pdf/ja/toc_ja.pdf
Related Services
Manual creation using GitHub and other tools
+81 35-321-3111[Tokyo]
Contact Us
Request for Information
TOP
SITEMENU