Efficient management, operation, and maintenance of manuals and documents

Currently, many companies are facing the important issue of managing and organizing large volumes of documentation.
Do you have any concerns regarding manuals like the following?

• Unable to access the desired information and documents
• The heading structure, layout, and notation/expression are not consistent, making the manual difficult to read.
• I want to effectively reuse common descriptions that exist in multiple manuals.
• Manual revision and update work requires a significant amount of effort...

Do you have such concerns? Human Science provides support for DITA implementation to solve these issues.

DITA Services Provided by Human Science

At Human Science, we mainly provide rewriting, coding, and translation services.
We also collaborate with partner companies to develop CMS.

Why rewrite before implementing DITA?

In DITA, information is described in topic units and shared across various manuals. This means that the same topic can be reused in multiple manuals, eliminating waste. This is called "topic reuse."
What if the reused text is unclear and difficult to read?
Human Science offers effective writing services to ensure that the benefits of DITA implementation are realized.
In cases where there are "multiple similar manuals" or "multilingual translations are pending," reviewing the manuals (preparation) is especially important.

Human Science Writing Services

1. Rewrite Service Before DITA Conversion

Have you completed the preparation of the manuals for the introduction of DITA? High-quality writing is essential for topic reuse.
Let's start by reviewing the manuals from the following perspectives and refining the text.

2. Topic-Oriented Writing Services for DITA Conversion

"Topic writing" often appears on DITA-related sites. What is the difference between general writing and writing that is conscious of DITA?
Human Science believes that the following three consciousnesses are important.

Write with the awareness that everything is a 'component'

All paragraphs/sentences that make up the manual are modularized and can be reused in other manuals.
It is important to write with the awareness that the text you are currently writing may be used in other manuals.
For example, using demonstrative pronouns like "this" and "that" to refer to the content of the previous paragraph, or sentences that cannot be understood without surrounding context, are not acceptable.

Write with the awareness that all paragraphs are 'tagged'

In general writing, the order and placement of paragraphs and sentences can be somewhat ambiguous.
On the other hand, when tagging, all paragraphs and sentences must clearly convey their meaning and purpose. It is important to carefully consider the placement and order when writing, so that there is no confusion about which tags to use during coding.

Write with the awareness that it is a 'structured document'.

In general writing, there are writing conventions. However, clarity is often prioritized, and exceptions are frequently allowed.
For example, creating new heading levels or increasing indentation can be mentioned.
In the case of writing for DITA, structured rules take precedence over clarity.
If the rules are deviated from, the text must be revised to conform to the structured rules during coding.
It is important to write while adhering to the structured rules.

3. Check the rewrite scope in the manual evaluation report in advance

You can check in advance the level of rewriting to be done, the quirks of the manual, and the scope of the rewrite.

Improvement Points (Sample Examples)
"Inconsistent Expressions", "Redundant Expressions", "Verbose Expressions", "Information Grouping", "Procedure Organization", "Unnecessary Pronouns", etc.

Related Services