MTのマニュアルを書くということ

直接MTとは関係ないけど、MTサイトを製品として誰もが当たるであろうクライアントへのマニュアルの書き方について思ったことのメモ。

当然だけど用語説明

「エントリー」＝「記事」
「カテゴリー」＝「項目or題目」
など、MT独自の用語は最初に軽く説明を置くとよい。

「エントリーの書き方」でまとめない

クライアントは「エントリーの書き方」から、各カテゴリの編集方法には行き着かない。絶対。
各カテゴリーごとに、たとえば「新着情報の編集方法」「会社概要の編集方法」と、全カテゴリとは言わないが2〜3の具体例を書き、最終的に「カテゴリーを選択すればいいのか」と気づきに運べればよい。カテゴリーごとにレイアウトが全く変わり、入力欄の方式も変わるようなら全カテゴリ記述する。

各カテゴリー別の書き方も詳細に

「○○と同様に再構築」のように要約しない。
さすがにログインはいいが、エントリー投稿画面を開き、投稿画面の各入力欄がどこに対応しているのかを明記し、保存の公開・未公開の設定を説明し、再構築のやり方まで全カテゴリー分明記する。
なぜならカテゴリーによって編集担当者が変わり、自分のカテゴリのやり方しか見ない可能性が高いからだ。