技術者のためのテクニカルライティング入門講座

目次

第1章 ロジカルライティング×テクニカルライティング活用の基礎知識

1.1 技術者の各文章がわかりにくい3つの理由

1.2 そもそも「論理的」とはどのようなことか

1.3 思考を効果的にアウトプットするための「ロジカルライティング」

1.4 「読み手」は目の前にいる人だけ?

1.5 「目的」ありき。読んだ人の行動を想定する

1.6 書き出す前にロジックを組み立てることが何より重要

1.7 情報をわかりやすく伝えるための「テクニカルライティング」

 

第2章 わかりやすく、簡潔な文章を書くテクニック

2.1 一文一義で書く

2.2 文を長くしない。「~(だ)が」、「~ので」で文をつながない

2.3 一文を短く。50字以内で収めるように

2.4 5W2Hを盛り込み、曖昧な文章にしない

2.5 メールの件名、文書のタイトルから目的が伝わるように書く

2.6 「話し言葉」と「書き言葉」を使い分ける

2.7 接続詞の使用は最小限に抑えて、効果的に使う

2.8 長くなりがちな文章を簡潔に仕上げるコツ

 

第3章 読み手に伝わる文章を書くテクニック

3.1 最も重要な内容を先に書く

3.2 形容詞や名詞句でなく、動詞でズバリと書く

3.3 否定表現に気を付ける

3.4 受動態と能動態を使い分ける

3.5 具体的に情報を盛り込んで書く

3.6 「など」を多用しない

3.7 レビューを受けて、わかりやすさを高める

3.8 最後の文でしっかりと締めくくる

 

第4章 読みやすさを高める文書フォーマット ~表現・表記のルール~

4.1 文書に必須の要素を適切に書く

4.2 要素の配置と書式には意味がある

4.3 ブロック化して要素を区切る

4.4 カッコは2種類を基本として使う

4.5 フォントの使い分けのセオリーを知る

4.6 階層構造を数字や記号で示す

4.7 箇条書きを効果的に使う

4.8 カタカナ語と英字表記の基本的なルール

 

第5章 実践編 ユーザーマニュアル・取扱説明書

5.1 ユーザーマニュアル・取扱説明書の作成ポイント

5.2 企画・設計をする

5.3 ユースケースを想定する

5.4 作業(タスク)を整理して説明する

5.5 手順の書き方

5.6 概要の書き方

5.7 参考情報の書き方

5.8 注意文の書き方

 

第6章 実践編 提案書

6.1 提案書の作成ポイント

6.2 情報を整理して、全体を設計する

6.3 スライド枚数の決め方

6.4 各スライドのポイントをタイトルで示す

6.5 箇条書きは7項目までにまとめる

6.6 表やグラフを活用する

6.7 図解や写真を使う

6.8 全体の流れを俯瞰して見直す

 

第7章 実践編 障害報告書

7.1 障害報告書の作成ポイント

7.2 障害報告書の読み手とロジックツリー

7.3 必須要素を適切に書き、社外文書の形式を整える

7.4 概要と事実を分けて整理する

7.5 事実、原因、対処の順に書く

7.6 原因をわかりやすく書く

7.7 再発防止策を示し、安心感を与える

7.8 リスクを減らすポイント

 

第8章 実践編 社外メール文

8.1 相手を納得させる社外メール文の作成ポイント

8.2 件名で要件を伝える工夫をする

8.3 重要な内容、相手にして欲しいことを最初に書く

8.4 トピックが一目でわかるように整理する

8.5 5W1Hまたは5W2Hを意識して書く

8.6 エモーショナルな表現を加える

8.7 日程や期限を明記する

8.8 署名を書いて行動につなげる

 

 

Vue.js入門 基礎から実践アプリケーション開発まで

ドラゴンクエストXを支える技術 ── 大規模オンラインRPGの舞台裏

関連記事

  1. Web技術 最強の指南書

    目次第1部 Webの通信プロトコルを学ぶ第1章 HT…

  2. エッセンシャルWPF:Windows Prese…

    目次第1章 はじめに新しいGUIとしてのWPF…

  3. プログラミング教育が変える子どもの未来 AIの時…

    目次第1章 なぜ、プログラミングを学ぶの?■ なぜ、…

  4. プログラマを育てる脳トレパズル 遊んでおぼえるP…

    目次Part1 ○×ゲームでおぼえるプログラミングの基本プロ…

  5. 効果4500倍! LINE@”神&#…

    目次第1章ネット戦略、激震走る。メールアドレ…

  6. 知って得する! おうちの数学

    目次第1章 おうち編1-01   目覚まし時計が同時…

  7. ハッキング・ラボのつくりかた 仮想環境におけるハ…

    目次第1部 ハッキング・ラボの構築第1章 ハッキング…

  8. SHIP 医療の現場を支え続けるシップヘルスケア…

    目次第1章 グループの理念と事業グループが掲げる「S…

最近の記事

  1. Microsft .NET C#
  2. れいといちかとまほうのトンネル
PAGE TOP