お問い合わせ

改訂・更新

英語表記
Revision
読み
かいていこうしん
別名
改訂

仕様変更や運用見直しに合わせて、文書の内容を直すこと。

解説

改訂・更新は、いったん作った文書を現状に合わせて直し続ける作業です。マニュアルやFAQが使われなくなる大きな理由は、「古いからどうせ違う」と読み手に思われることにあります。仕様変更や運用の見直しに合わせて内容を直し、いつ時点の情報かを示すところまでが一続きの作業になります。

改訂の契機と担当者、棚卸し日を先に決めておく

  • 改訂の契機(リリース、価格改定など)を事前に紐づけておく
  • 文書ごとに管理者を決める
  • 定期的な棚卸し日をカレンダーに入れる

全文書を同じ頻度で見直そうとすると回らない

文書の数が増えるほど、すべてを定期的に点検する運用は続きません。参照回数の多い記事、問い合わせが集中する領域の記事、誤ると影響が大きい手続きの記事から優先順位をつけます。閲覧の少ない記事は、棚卸しのときに残すか統合するかを判断する対象に回します。手をつけない文書を放置するのではなく、「今は見直さない」と決めておくことも運用の一部です。

何を直したかが分かる形で残す

更新日だけが新しくなって中身の変更が分からないと、読み手は前回からどこが変わったのかを追えません。料金や手続きのように誤ると影響が出る箇所は、改訂履歴に変更点を一行で残します。誤字の修正まで履歴に並べると読みづらくなるので、内容が変わる改訂と表記だけの更新を分け、前者だけ履歴に載せる運用が扱いやすいところです。