要約：「今から始めるテクニカルライティング」 -雑誌『Software Design 2024年4月号』
記事の概要
この記事は
雑誌『Software Design 2024年4月号』
第2特集 今から始めるテクニカルライティング 伝わる／役立つドキュメント作成のポイント
の要約になります。
テクニカルライティングの基本
テクニカルライティングとは
テクニカルライティングは、読み手や目的に合わせて技術をわかりやすく伝える技術です。
この技術を使うことで、以下の効果が得られます：
- 読み手に合わせたドキュメントになる
- 情報が探しやすいドキュメントになる
- 読み手が理解しやすい文章になる
読み手に合わせたドキュメント作成
読み手の前提知識と目的を考慮することが重要です。
以下の点に注意しましょう：
- 適切な用語を選択する
- 読み手の目的に合わせて情報を絞り込む
- 必要に応じてドキュメントを分割する
- 読み手の範囲を絞り込む
アウトラインの重要性
アウトラインは、ドキュメントの構造を示し、読み手が全体像を把握しやすくします。
アウトライン作成の手順は以下の通りです：
- 伝える情報の書き出し
- 情報の整理
- 見出しにする要素の選択
- 見出しへの名前付け
情報の整理では、階層化と順序付けが重要です。階層化は「全体から部分へ」または「概要から具体へ」の視点で行います。順序付けは、重要度、ニーズの大きさ、既知から未知、時系列などの観点で行います。
明確な文章を書く技術
ドキュメントは一部しか読まれないことを前提に、以下の点に注意して書く必要があります：
- 重要なことから書く
- できるだけ短く書く
- 読み手の視点で書く
効率よく理解できる文章を書くためのテクニックには以下があります：
- 一文一義で書く
- 一文を短くする
- 読み手の視点で書く
- 能動態と受動態を適切に使い分ける
- 主語と述語を対応させる
- 係り受けを明確にする
- 並列の情報は箇条書きにする
- 読点を適切に打つ
誤解なく理解できる文章を書くためには：
- できるだけ具体的に書く
- 肯定形で書く
- 二重否定を使わない
- 「の」は1文に2つまでにする
段落の作り方
段落は1つのトピックについて書きます。パラグラフライティングの技術を用いて、段落の最初にトピックセンテンスを置き、その後にサポートセンテンスを続けます。
トピックの展開では、「概要から詳細へ」「既知の情報から未知の情報へ」という原則を意識します。また、文と文のつながりにも注意を払い、論理的な文章構成を心がけます。
以上のテクニックを活用することで、読み手にとって理解しやすく、効果的なドキュメントを作成することができます。
特集を読んでみた感想
特に印象に残ったのは以下の点です：
- 読み手を常に意識することの大切さ
- アウトラインの作成が効果的なドキュメント作成の鍵となること
- 具体的で明確な文章を書くためのテクニック
わたしは会社などで、ドキュメント作成スキルを教えてもらうこと、習うことはほとんどありませんでした。特集を読んでみて、テクニカルライティングの重要性と基本的な技術について深く学ぶことができたと感じています。「ドキュメントがなんかイマイチなんだよなあ」と思っている人には、ぜひ読んでみて欲しい特集です。
今後は学んだテクニックを意識的に取り入れ、より読みやすく効果的なドキュメントを作成していきたいと思います！
Discussion