開発ドキュメントでは、技術や業務の複雑な仕組みを分かりやすく伝える必要があります。その意味で箇条書きは、開発ドキュメントにおいて積極的に使いたい表現手段といえます。本講座で、箇条書きの上手な使い方を学びましょう。
連載
開発ドキュメントの悪文修正術［箇条書き］
目次
-
第2回 上位概念をそろえる
概念が混在すると分かりにくくなる
箇条書きの各項目には「上位概念」があります。これをそろえることが箇条書きで極めて重要です。ここでいう上位概念とは、「目的」「目標」「手段（手順）」「理由」「背景」「問題」「原因」といったことです。
-
第3回 「割り込み箇条書き」は避ける
説明文は箇条書きの前で完結させるべし
箇条書きにしたことで余計に読みづらくなるのでは本末転倒です。ところがそういう箇条書きが、開発ドキュメントでよく見受けられます。
-
第4回 項目を短く表現する
一目で認識しやすいようシンプルに
箇条書きの各項目は、「パラメーターのチェック」のような名詞形（体言）でも、「パラメーターをチェックする」のような文でも構いません。ただし一目で認識しやすいように、短くシンプルに表現します。
-
第1回 箇条書きを使うべき理由
箇条書きの前には説明文を付けよう
開発ドキュメントにおいて多用したい表現の一つは、箇条書きです。箇条書きをうまく使うことで、構造がはっきりとした分かりやすい表現にできます。開発ドキュメントで箇条書きを用いる上でのポイント四項目を紹介します。
日経クロステック Special
What's New
経営
- コンテナ特有の攻撃リスクと対処法とは？
- 【先進事例紹介】DXを迅速化する必須技術
- コンテナ監視の落とし穴を回避するには？
- 「改革支援メニュー」で課題ごとに対応
- 企業の組織課題解決に健康データを活用！
- 企業成長には「○○な人事戦略」が必要
- ハイブリッドな研修で研修効果を最大に！
- 事例紹介！DXで推進する働き方改革新時代
- 新しい働き方とはー。DX、人と組織の活用
- テレワークでも共同作業 その方法とは？
- 社員の本音を知って離職を防ぐ新技術
- ハイブリッドワークを成功させる秘訣とは？
- 「まずは電話で問い合わせ」が激減
- “正しいPDF”で時間もコストも削減
- 日本IBM、30社33部門に感謝状を贈呈
- Hondaのカーシェアが挑む価格戦略
- 「予算の組み替え」でDXの原資を生む方法
