箇条書きにしたことで余計に読みづらくなるのでは本末転倒です。ところがそういう箇条書きが、開発ドキュメントでよく見受けられます。その文例を次に挙げます。

よくある文例①

ディレクトリーサーバーの仕様に合わせて、

  • データ検索時のソート処理の修正
  • NULLデータを処理するためのアプリケーションやバッチの修正
  • データを移行するためのツールの作成

を行う。

 この文例では、一つの文に箇条書きが挟み込まれています。これは、いわば「割り込み箇条書き」。こんな表現では、せっかく箇条書きにしたことが台無しです。文を最後まで読まないと何が書いてあるのか分からないからです。そのため読み手は、いったん最後まで読んで何が書いてあるのかを理解し、その上でまた最初から箇条書きを読み直す必要が生じます。

 説明文は、箇条書きの前で必ず完結させる。これを徹底してください。よくある文例①の修正例を以下に挙げます。

この先は有料会員の登録が必要です。「日経SYSTEMS」定期購読者もログインしてお読みいただけます。有料会員(月額プラン)は初月無料!

日経クロステック ラーニング/日経クロステックには有料記事(有料会員向けまたは定期購読者向け)、無料記事(登録会員向け)、フリー記事(誰でも閲覧可能)があります。有料記事でも、登録会員向け配信期間は登録会員への登録が必要な場合があります。有料会員と登録会員に関するFAQはこちら