メンテナンス性

解説

メンテナンス性は、マニュアルやFAQなどの文書について、作成後の修正や更新のしやすさを表す性質です。もともとはソフトウェアや設備の品質を表す言葉で、ソフトウェア品質の国際規格ISO/IEC 25010でも「保守性（Maintainability）」として品質特性の1つに挙げられています。文書の場合、作成した直後は内容を把握している人が多いため、修正は容易です。一方で、担当者が替わると、どこに何が書かれているかが分かりにくくなり、手を付けにくくなることがあります。

判断基準

文書のメンテナンス性は、書き方しだいで大きく変わります。メンテナンス性を下げる要因と、上げるための工夫は次のとおりです。

下げる要因	上げる工夫
同じ情報を複数箇所に書いている	1か所に書いて参照先を示す
画面全体のスクリーンショットを多用	必要な部分だけを切り出す
ファイル形式が編集しにくい	ツール上で直接編集できる形にする

実務での使われ方

文書を書き始める前に、どの情報をどこに置くかの決まりをチームで共有しておくと、作成後の修正や更新が楽になります。たとえば、同じ説明を複数の文書に書かず、1か所にまとめて他の文書からは参照先を示す、という方針を先に共有しておきます。