テクニカルライティング

はじめに

　設計書というものを書く経験がなく、今回チャレンジさせてもらったが、書いたことないねと言われて、別の仕事をさせられた。そのときに、詳細設計書は、決められたフォーマットがあるが、その上の基本設計書になるとフォーマットとなる決められた方がないと言われた。この悔しい経験からテクニカルライティングを調べようということになった。

対象者は以下の通りです：

• ソフトウェア・エンジニア
• ソフトウェア工学またはコンピュータサイエンスの学生
  さらに、エンジニアと接する職務（プロダクトマネージャーなど）に就いている多くの人々も、これらのコースから恩恵を受けています。

学習目標

このコースではテクニカルライティングの基礎を学びます。このクラスを修了すると、以下のことができるようになります：

• 略語や頭字語も含め、専門用語を統一して使う。
• あいまいな代名詞を認識する。
• 能動態と受動態を区別する。
• 受動態の文を能動態に変換する。
• 能動態が受動態より優れている3つの方法を特定する。
• 文章をより明確に、より魅力的にするための戦略を少なくとも3つ考える。
• 文章を短くするための戦略を少なくとも4つ考える。
• 箇条書きリストと番号付きリストの違いを理解する。
• 役に立つリストを作成する
• パラグラフの効果的なリードセンテンスを作る
• 各段落を1つのトピックに集中させる
• 各文書の冒頭にキーポイントを述べる。
• 対象読者を特定する。
• 対象読者がすでに知っていることと、対象読者が学ぶべきことを見極める。
• 「知識の呪縛」を理解する。
• 慣用句を特定し、修正する。
• 文書のスコープ（目標）と読者を明記する。
• 長いトピックを適切なセクションに分割する。
• コンマ、括弧、コロン、エムダッシュ、セミコロンを適切に使用する。
• Markdownの初級能力を身につける。

まとめ

今日は概説として、書いてみた。下記に関しては、別途説明したいです。

• コンマ、括弧、コロン、エムダッシュ、セミコロンを適切に使用する。
• Markdownの初級能力を身につける。

最後に

　いかがでしたか？私の経験も踏まえて書いたので感じることがある人もいるのではないでしょうか？これからも更新していきます。よろしくお願いします。

技術者のためのテクニカルライティング入門講座【電子書籍】[ 高橋慈子 ] 価格：2,420円 (2025/5/27時点) 楽天で購入