技術コンテンツとは——仕様を顧客の判断材料へ変える編集

工場の設備担当者が、熱のかかる配管に使うシール材を探している。候補の製品ページには耐熱性能を示す値がある。しかし、どの材料や流体を対象に、どんな圧力と時間で確かめた値なのかが見つからない。数字は読めても、自社で使えるかは決められない。

技術コンテンツとは、製品や技術の仕様、仕組み、試験結果、使い方を、顧客が選ぶ、導入する、使う、直すときに確かめられる情報へ編集したものである。数値や専門用語を並べるだけでなく、誰のどの判断に使うかに合わせて、条件、手順、根拠、限界まで示す。

製品ページ、仕様表、取扱説明書、FAQ、技術記事、事例は、いずれも技術コンテンツになり得る。名前で決まるのではない。読み手が必要な事実を見つけ、次の行動を決め、必要なら元の資料へ戻れるかで役割が決まる。

冒頭のシール材は説明用の架空例であり、特定製品の性能や安全手順を示さない。実際の選定、取り付け、保守では、製品ごとの最新公式文書と専門担当者の確認が必要である。本稿では、手元にある専門情報を顧客の判断へ変える編集に範囲を絞る。

技術コンテンツは、仕様を顧客が決めるための情報に変える

仕様を公開しただけでは、判断材料になったとは限らない。「最高温度」「処理速度」「精度」のような値があっても、誰が何を選ぶための値か、適用条件は何か、外れる条件ではどうなるかが分からなければ、読み手は営業担当へ同じ質問を戻すことになる。

出発点は、社内が伝えたい機能ではなく、読者が終えたい行動である。Googleの技術文書講座は、良い文書を、読者が作業に必要とする知識と技能から、すでに持つ知識と技能を引いたものとして説明する。[S1] 同じ製品でも、開発者と購買担当では知っている言葉も確かめたい項目も違う。

GOV.UKの公開ガイドも、誰が、何をしたいか、なぜしたいかを、分析、問い合わせ、調査などから確かめるよう求める。[S2] 既存のパンフレットを公開するために読者像を後付けするのではない。営業やサポートへ届いた質問を一件選び、質問した人、決めたかったこと、足りなかった情報を書く。

たとえば「このシール材は使えるか」という質問なら、読み手の業種名だけでは足りない。候補を絞りたいのか、取り付けたいのか、漏れの原因を探したいのかで答えは変わる。読後に「候補から外す」「図面を添えて相談する」「取り付け条件を確認する」のどれができればよいかまで決める。

技術広報とは何かでは、技術を企業への信頼や対話につなぐ活動を扱った。技術コンテンツは、その活動に使う中身の一部である。

会社の価値を広く伝える前に、一つの技術情報が一つの判断へ正しく答えているかを確かめる。

選ぶ、導入する、使う、直すでは必要な答えが違う

技術情報を一枚の長い資料へ集めれば、網羅したように見える。ところが、候補を比較する人が欲しい仕様表と、現場で取り付ける人が欲しい手順は、読む目的も時間も異なる。異常が起きた人は、会社沿革や技術の背景ではなく、症状から安全な対処へ急いで進みたい。

公開標準OASIS DITA 1.3の技術コンテンツ版は、情報を概念、参照、手順、問題解決などへ分ける。参照は仕様や必要機器のような事実を支え、手順は誰がいつどの順で行うかを示す。[S3] これは採用必須のCMS形式ではなく、問いが違えば情報の形も変わることを確かめる一例である。

顧客の判断に置き換えると、「選ぶ」には適用条件と比較できる仕様、「導入する」には前提、工具、順番、完了状態が要る。「使う」には通常時の確認項目と点検時期、「直す」には症状、考えられる原因、対処、停止や問い合わせの条件が要る。

DITAの問題解決情報も、症状、原因、対処の組で示し、必要に応じて担当者と手順を持たせる。[S4]

「動かないときはお問い合わせください」というFAQは窓口を示すが、利用者が安全に切り分けられる範囲を説明しない。反対に、専門家だけが行う作業まで一般公開して自己解決を促すのも危険である。

分けることは、同じ仕様値を四カ所へ複製することではない。確認済みの正本を一つに保ち、各ページから参照する。値が変わったときにすべてのコピーを探す運用では、古いページが残りやすい。読者の問いは分けても、根拠となる事実は一つへ戻れるようにする。

数値には条件・方法・限界を添える

技術コンテンツで目を引きやすいのは数字である。数字は比較を速くする一方、条件を外すと別の意味になる。最大値と通常値、試験片と実機、短時間と連続使用、特定環境と顧客の現場を同じ性能として扱うことはできない。

公開前には、少なくとも何を測った値か、単位、対象、試験・計算方法、成立する条件、外れる条件、資料の更新日を対応させる。比較値なら相手と期間も要る。「従来比」だけでは、旧製品、他社製品、社内試作のどれと比べたかを読者が確かめられない。

NISTは自らの測定結果について、不確かさとその求め方を報告し、詳しい方法を別資料で示す場合も、現在の測定工程と一致するよう資料を更新する方針を示す。[S5]

一般製品へ同じ計算を義務づける資料ではない。それでも、測った値は単独で浮かせず、解釈に必要な前提と一緒に管理するという実務は参考になる。

数値の出所が試験報告書なら、製品ページから報告書名、版、該当箇所へたどれるようにする。営業資料へ強い数字を抜き出すときも、対象と条件を残す。根拠へ戻れない数字は、担当者が異動した後に確かめられず、更新も訂正も遅れる。

限界を書くことは、製品を弱く見せることではない。対象外が分かれば、顧客は合わない候補を早く外せる。公開できない試験条件や個別判断が残るなら、「図面と使用条件を添えて確認」「この作業は有資格者へ依頼」のように、次に誰が何を確かめるかを示す。

技術者と編集者は、違う箇所を確認する

一人の技術者へ「分かりやすい記事を全部書いて」と頼むと、確認と執筆が同じ人へ集中する。編集担当者だけで整えると、読みやすくても条件を落とすおそれがある。技術者と編集者は同じ文章を共同で作るが、最初から同じ仕事をする必要はない。

技術担当者は、値、用語、成立条件、対象外、危険、参照元、最新版を確認する。編集担当者は、誰のどの判断へ答えるか、必要な順に読めるか、社内語を知らなくても探せるか、次の行動が明確かを確認する。営業とサポートは、公開後も繰り返し届く質問を戻す。

題材は新しい発表だけに求めなくてよい。技術広報のネタを探す方法で扱った開発記録、顧客質問、失敗のうち、同じ判断で繰り返し止まっているものを選ぶ。

最初の一本なら、営業とサポートが毎月説明している質問のほうが、読者と確認担当を決めやすい。

制作票には、読者、終えたい判断、元資料、確認者、公開できない情報、更新のきっかけ、正本の場所を書く。製品仕様が変わった日だけでなく、試験方法、対応部品、画面、法令、問い合わせ先が変わったときも見直す。公開日より、次に誰が確認するかを残す。

この分担があると、編集者は専門性を薄めず、技術者は全文を一から書かなくてよい。初稿を作る前に、顧客が判断するための質問を編集者が並べ、技術者が答えと証拠を埋める。最後に、担当外の読者が同じ答えへたどり着けるかを確かめる。

閲覧数より、迷わず判断できたかを測る

技術コンテンツの閲覧数が増えても、正しい製品を選べたとは限らない。滞在時間が長いことも、熟読ではなく答えが見つからない状態かもしれない。検索、閲覧、問い合わせ、商談を分け、各段階で観測できることだけを読む。

まず一つの作業を決める。たとえば「条件に合わない候補を外し、相談に必要な情報を見つける」である。実際または想定する読者にページを渡し、正しい箇所へ到達できたか、時間はどれくらいか、間違ったまま完了したと思っていないか、答えに確信を持てたかを見る。

GOV.UKのサイト評価ガイドも、現実的で正解が明確な作業を用意し、完了、所要時間、誤完了、容易さ、答えへの確信を測るよう案内する。[S6]

英国政府サービス向けの方法であり、民間の製品ページへ同じ人数や手順を義務づけるものではない。小さな確認でも、PVだけでは見えないつまずきを発見できる。

公開後は、サイト内検索で答えのない語、ページ内で次の資料へ進んだ割合、既出の質問が問い合わせで繰り返される回数、営業やサポートが資料を再利用した場面を記録する。

技術広報のKPIで扱った認知や事業成果とは分け、まず一ページが一つの判断を助けたかを見る。

数字が悪いときに、すぐ記事を増やす必要はない。必要な仕様が見つからないなら見出しと導線を直す。条件が欠けているなら元資料と確認工程を直す。読者ごとに答えが違うならページを分ける。そもそも質問が少ないなら、営業とサポートへ戻り、優先した判断が合っていたかを確かめる。

技術コンテンツを作る最初の一歩は、新しい記事を書くことではない。繰り返し届いた一つの質問を選び、誰が何を決めたいかを言葉にする。

次に、選定、導入、使用、復旧のどこへ答えるかを決め、仕様へ条件、方法、限界を戻す。読者が迷わず次の行動を選べたとき、専門情報は初めて顧客の判断材料になる。