お問い合わせ

改訂・更新

英語表記
Revision
読み
かいていこうしん

仕様変更や運用の変更に合わせて、マニュアルやFAQなどの文書の内容を改めること。

解説

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

実務での使われ方

改訂を滞らせないために、改訂の契機と担当者、棚卸し日をあらかじめ決めておきます。

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

契機が発生したら臨時で改訂し、契機のない文書は定期の棚卸しで点検する、という二本立てで運用すると、改訂の漏れを防ぎやすくなります。

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

注意点

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