ライター向けマニュアルの作り方：一度しか読まれない文書に、何を書くか

ライターに渡すマニュアルは、書き始めると際限なく伸びます。これまで指摘してきたことを思い出すたびに1行増え、目次が三階層になったところで、これは読まれるのだろうかという疑いが出てくる。それでも消す理由が見つからず、そのまま渡すことになります。

判断の軸を1本だけ用意します。その項目は、一度読めば足りるのか。それとも書くたびに参照しないと効かないのか。 後者を文書に書いても、書いている最中に開かれないので効きません。この軸で振り分けていくと、マニュアルに残る項目は自然に減ります。

以下は目次の決め方だけの話で、良い記事の書き方そのものには踏み込みません。

マニュアルは、渡した日にしか開かれない

前提を一つ置きます。マニュアルは一度読んで頭に入れてもらう文書であって、執筆中に開くものではありません。

表記ルールの一覧が守られないのは、この前提と用途が食い違っているからです。「お問合せ」と打ちそうになる瞬間は一記事に何度も来るのに、参照先は別タブの文書の中にある。毎回の参照が前提の項目を、一度きり読む文書に載せてしまっている。ライターの意識ではなく、置き場所のほうが原因です。

だから目次を組む前に、集めた項目を二つの軸で見ます。同じ判定が繰り返し起きるかどうかと、答えが一意に決まるかどうか。

	答えが一意に決まる	答えが人によって割れる
毎記事のように出てくる	仕組みへ降ろす	ここがマニュアルの本体
たまにしか出てこない	出たときに調べれば足りる	都度相談。書くと目次だけ太る

左上が降ろす項目、右上が残る項目です。左下と右下を熱心に書き込むと、目次は立派になって中身が薄くなります。

表記ルールの章は、そのまま辞書に引っ越せる

左上に入るものは、媒体が違ってもだいたい似ています。表記ゆれ、使ってはいけない語、冗長な言い回し、全角と半角、句読点、文体の統一、一文の長さ、タイトルや抜粋の書式。日本語校正マネージャーが見ている8種別は、裏返せば「マニュアルから降ろせる章」の一覧でもあります。

引っ越しの単位は、文章ではなく行です。「問い合わせは『お問合せ』と書かない」という一文は、検出表記・推奨表記・一致方法の3列に分解できる。辞書の作り方と、入れてはいけない語の基準は表記ゆれ辞書の作り方にまとめました。

この引っ越しで真っ先に落ちるのが、理由の記述です。マニュアルには「読み手が検索するときの表記に合わせる」と書けたのに、3列の表にすると入る場所がない。辞書のエントリには、推奨表記とは別に補足欄を持たせてあります。この仕様にしたのは、理由の行き場が無いと、引っ越した先で「なぜそう直すのか」だけが毎回こぼれ落ちるからです。ここに書いた文は、指摘に添えてライターの画面へ出ます。文書の中で説明するより、直す瞬間に見えるほうが効く。

数字は決める。ただしマニュアルには書かない

「一文は短く」「読点を打ちすぎない」。この手の項目は、マニュアルに書いても守りようがありません。短いの基準が人によって違うので。

かといって数字を決めて載せると、今度は左上に落ちます。参照が要る項目に化けるからです。決めるのは一度、置く場所はルールの設定値のほう。日本語校正マネージャーなら、一文の上限も読点の数も、語尾と接続詞が何回続いたら言うかも、既定値が入った状態から始まります。まだ基準を決めていない媒体は、その既定のまま何本か書いて、出てきた指摘を見てから動かすほうが早い。最初にどこまで数字を信じるかという話は一文の長さの基準に書きました。

決めた値は媒体ごと・書き手ごとに変えられます。ただし目次を決める段階では、そこまで踏み込まなくてかまいません。

残したくなるが、残らない三つの章

降ろす対象は表記だけではありません。書きたくなるのに寿命が短い章が、ほかに三つあります。

ツールの操作手順。 スクリーンショットを貼った手順書は、画面が変わった日に嘘になります。更新の担当者も決まっていないことが多い。日本語校正マネージャーには読み取り専用のオンボーディングツアーを管理画面編とエディタ編で用意してあって、エディタ編は同梱のサンプル原稿を校正した結果を見せます。書きかけの記事を書き換えないので、新人が初日に一周できる。操作の説明は画面側に置いたほうが長持ちします。

NG表現の一覧。 薬機法医薬品、医療機器等の品質、有効性及び安全性の確保等に関する法律。化粧品・健康食品・医療機器などの広告で、効能効果の言い方を制限する。や景表法不当景品類及び不当表示防止法。「No.1」「最安」のように実際より良く見せる表示や、根拠のない比較表示を規制する。の言い換えを表にすると、量も更新頻度もマニュアルの手に負えません。語そのものは禁止語辞書へ移し、どのレイヤーからも無効にできない強制ルールとして固定しておく。マニュアルに残すのは「なぜ止まるのか」と「止まったときに誰へ言うか」の2行で足ります。

公開前のチェックリスト。 巻末に付けたくなりますが、読むタイミングが違う文書です。マニュアルは渡した日、リストは公開のたび。綴じてしまうと、毎回開くべきリストが「初日に読んだ文書」の一部になって、開かれなくなります。

残った項目で目次を組む

降ろし終わって残るのは、判断が要って、しかも記事ごとに答えが変わるものだけです。たたき台として6章を置きます。

6章目は短くて済みます。日本語校正マネージャーの場合、投稿者・寄稿者が自分で消せるのは「この指摘のみ」と「この投稿のみ」の2つまで。ライター単位・カテゴリ単位・ルールごと止める操作は編集者以上に限ってあるので、書くことは残り3つを誰に頼むかだけです。権限で決まっている範囲を、文章で説明し直す必要はありません。

各章はできるだけ薄く保ちます。厚くなってきたら、その章のどこかに左上の項目が紛れ込んでいるはず。

分けると、更新の担当も分かれる

この分け方が効いてくるのは、渡した後です。

表記の決定は運用しながら増えます。新しい商品名、他社サービスの正式表記の変更、全角か半角かで揉めた結果。マニュアルの改訂で反映しようとすると、改訂できる人の手が空くまで止まりますが、辞書に移してあれば、辞書を触れる編集者が1行足して終わる。マニュアル側は、媒体の方針そのものが変わったときだけ開けばよくなります。

降ろした項目が執筆中・保存時・公開前のどこで顔を出すかは編集フローに校正を組み込むに書きました。ルールと辞書をどの単位で分けて持てるかは、日本語校正マネージャーの製品ページで見られます。