マニュアル・技術文書｜書き方をそろえ、直す場所を1つに
同じ注意書きを、何か所も直していませんか？
機種ごとの説明書に、同じ手順や注意書きを書き写していませんか。直すたびに、すべての説明書を探して写すことになります。
文書を決まった型で書き、同じ部品を何冊でも使い回す。書き方をそろえ、直す場所を1つにします。
こんな状況は、ありませんか。
- 同じ手順や注意書きを、機種の数だけ書き写している
- 書く人によって、見出しや手順の書き方が違う
- 改訂のたびに、どこが変わったかを目で探している
- AI に読ませても、正しい答えが返らない
こんな場面を、想定しています。
よくある場面の例です。導入事例ではありません。
機種ごとの取扱説明書
共通の手順や注意書きを、多くの機種の説明書に載せる
同じ文章を機種の数だけ書き写し、直すときはすべてを探します。共通の部分を1つにまとめて使い回すと、直す場所は1か所になります。
社内の業務手順書
担当者ごとに書き方が違う手順書を、そろえる
書く人によって、見出しの付け方や手順の書き方が変わります。決まった型で書くと、読む人が迷わず、AI にも読み取りやすい文書になります。
翻訳する文書
日本語の説明書を、いくつもの言語に訳す
同じ文章が何度も出てくると、そのたびに訳すことになります。部品として使い回すと、訳す量を減らせます。
なぜ、起きるのですか。
原因 1
見た目で書いている
Word などで見た目を整えて書くと、どこが手順で、どこが注意書きかが、ソフトや AI に伝わりません。
原因 2
部品が分かれていない
同じ内容が、説明書ごとに別々に書かれていると、直す場所が増えます。
原因 3
型がない
書き方の決まりがないと、人ごとに書き方が変わります。
解決の形
今
- 説明書ごとに書く同じ注意書きを書き写す
- 直す場所が多い全部の説明書を直す
- 違いを目で探す改訂のたびに見比べる
これから
- 型で書く外れた所を知らせる
- 部品を使い回す直すのは1か所
- 人と AI に届ける機種や版の情報ごと
当社による整理です。緑の枠は、いちばん変わるところです。
これから 1
型で書く
DITA などの決まった型に沿って書き、型から外れた所を、書いている途中で知らせます。
これから 2
部品を使い回す
同じ注意書きを複数の説明書から参照し、直すのは1か所にします。
これから 3
人と AI に届ける
書いた文書を集め、機種や版の情報を付けたまま、Web や AI に届けます。
始め方
今ある資料や文書から、小さく始められます。
01
1冊を選ぶ
改訂の多い説明書を、1冊選びます。
02
型と部品を決める
手順、注意書き、仕様など、文書の役割と部品を決めます。
03
書いて、届ける
型で書き直し、届け方を決めます。
導入の前に、確かめておきたいこと
検討の途中でよく確かめられる点を、先にまとめました。
- 今の文書：Word や PDF の文書を、型に沿った形に移す作業が要ります。進め方は一緒に決めます。
- 書き方の決まり：型を決めるところから、情報の構造化支援として手伝います。
- 向かない場面：1回だけ使う文書や、改訂のない文書には、手間に見合わないことがあります。
- 料金：個別にお見積りします。
最終更新日：
よくいただく質問
DITA を知らなくても、始められますか。
はい。何のために型をそろえるかを決めるところから、一緒に進めます。
今の Word の文書は、無駄になりますか。
中身はそのまま使います。書き方の形を、型に合わせて移します。
AI の答えは、よくなりますか。
手順や注意書きの役割が文書に残るため、AI が正しい箇所を見つけやすくなります。答えの正しさは、使う AI と文書の中身にもよります。
使う製品
Oxygen XML Editor
決まった型で文書を書き、検査する
Fluid Topics
文書を集め、人と AI に届ける
関連するコラム
ほかの業務から探す
一覧
業務から探す
課題を、
お聞かせください。
製品が決まっていなくても、相談できます。いまの状況と、困っていることをお知らせください。進め方を一緒に整理し、必要なときは、デモで実際の画面をお見せします。
