SEのための 「構造化」文書作成の技術

[表紙]SEのための 「構造化」文書作成の技術

A5判/304ページ

定価(本体2,180円+税)

ISBN 978-4-7741-3650-9

ただいま弊社在庫はございません。

→学校・法人一括購入ご検討の皆様へ

書籍の概要

この本の概要

SEの仕事に占める文書作成の割合は小さくありません。実際,要求仕様書や提案書などといった初期文書から取扱説明書や各種報告書に至るまで,必要な文書類は山のようにあります。文章が苦手などとは言っていられません。しかし,表現上の注意以前に,まず文書のまとめ方がわからないという人が多くいるのです。本書は,表現の前の「文章の組み立て方」に焦点を当てています。文書の作成に構造設計の考え方を導入し,単なる文章論ではなく文書のプランニングからの重要性を説き,著者の経験から得られた実際の事例を多数取り上げます。

こんな方におすすめ

  • 業務上,各種文書を作成しなければならないSE
  • 文章の書き方はさまざま勉強したが,そもそも組み立て方に難がある人
  • SE的思考で効率よく文書の作成もこなしたい人

目次

  • はじめに

第1章 書くということ

1.1 技術文書の問題点

  • 技術文書の問題点は何か
  • どうすれば解決するか

1.2 技術文書の種類

  • 技術文書の種類
  • 本書で取り上げる技術文書
  • 関連するその他の文書

1.3 テクニカルライティングとは

  • テクニカルライティングの重要性
  • テクニカルライティングの効用
  • マニュアルライティング専門部署との連携

1.4 読解力から「書く力」へ

  • 読解力の養成
  • 「書く力」の養成
  • 「書く力」から読解力へ

1.5 書くことで頭を整理する

  • 書くための準備作業
  • 実際に書く作業
  • 書いたものを見直す作業

1.6「 書く力」をビジネスの武器に

  • ビジネスは書くことで始まる
  • 効率的な業務遂行は「書く力」から
  • 「書く力」から「話す力」へ
  • SEと文書作成

第2章 文書のプランニング

2.1 文書作成のステップ

  • 文書作成の流れ
  • 文書作成の5つのステップ
  • 文書作成の構造的工程把握
  • 文書作成で大切なこと

2.2 プランニング工程の作業

  • 主題を選定する
  • 文書の目的を明確にする
  • 誰が読むのかを明確にする
  • 執筆量を見積もる

2.3 メッセージを明確にする

  • メッセージとは何か
  • 書く目的はメッセージを伝えること
  • メッセージの書き方

2.4 アブストラクトの書き方

  • アブストラクトとは
  • アブストラクトの作成方法
  • アブストラクトの作成例

2.5 文書タイトルの付け方

  • 文書タイトルの付け方の原則
  • 文書タイトルの付け方の例

第3章 材料の収集

3.1 材料収集工程の作業

  • 事実を基に展開するために,材料を集める
  • 材料を取捨選択する
  • 材料を吟味する
  • 情報整理に役立つKJ法

3.2 日常生活での心構え

3.3 Webの活用

  • 検索の方法
  • 「お気に入り」の活用
  • Web の活用例
  • Web 情報の活用の留意点

第4章 文書の構造設計

4.1 構造設計工程の作業

  • 結論をまとめ,最初に配置する
  • 情報の配置,順序を考える
  • パラグラフを意識する

4.2 文書の構造化

  • 文書を構造化することとは

4.3 演繹法と帰納法の活用

  • 演繹法
  • 帰納法
  • 文書作成と演繹法/帰納法
  • 演繹法/帰納法の活用

4.4 文書の構造を決める

  • 文書の基本構成
  • 文書の構造の決め方

4.5 目次の作り方

  • 目次番号の付け方
  • 目次タイトルの付け方
  • 目次タイトルを付けるときの留意事項

4.6 パラグラフを意識する

  • パラグラフとは
  • パラグラフを意識して文章を見る
  • トピックセンテンスを配置する
  • 論理展開上でパラグラフが担う意味/役割
  • パラグラフの構成
  • パラグラフの連結
  • 小見出しの利用

第5章 文書の執筆

5.1 執筆工程の作業

  • 文章作成の基本姿勢
  • 文の構成の基本事項

5.2 明確な文章を書く

  • 文章を明確にする10か条

5.3 事実と意見を区別して書く

  • 事実と意見の違い
  • 事実の書き方
  • 意見の書き方

5.4 用字/用語などの使い方

  • 用字/用語などの基本

5.5 読点の使い方

  • 読点使用の基本
  • 読点の使い方

5.6 箇条書きを活用する

  • 箇条書きの基本
  • 箇条書きの留意事項
  • 箇条書きの例

5.7 図表の活用

  • 図の活用の基本
  • 図の種類
  • 表の活用の基本
  • 図作成時のチェックリスト

5.8 執筆ルールの作成

  • 執筆ルールの必要性
  • 定めておくべき基本ルール
  • 図版に関する基本ルール

第6章 文書の推敲

6.1 推敲工程の作業

  • 推敲のポイント
  • 効果的な見直し法

6.2 推敲のチェック項目

  • チェック項目

6.3 推敲の事例

  • A君の文章
  • A君の文章に対する考察
  • 改善例

6.4 ビジュアル表現の工夫

  • ビジュアル表現の効果
  • ビジュアル表現の工夫点
  • パソコンの活用

第7章 文書作成技術の応用

7.1 要求仕様書の書き方

  • 要求仕様書とは
  • 要求仕様書作成時のステップ
  • 要求仕様書の記載項目
  • 要求仕様書作成上の留意事項
  • システム提案書との比較検討

7.2 システム提案書の書き方

  • システム提案書とは
  • システム提案書作成時のステップ
  • システム提案書作成のためのチーム編成
  • システム提案書の記載項目
  • システム提案書作成上の留意事項
  • システム提案書はSE 力の現れ

7.3 マニュアルの書き方

  • マニュアル作成の概要
  • ソフトウェアマニュアルの種類
  • マニュアルの構造
  • 目次作成のポイント
  • マニュアルの構造のチェック
  • パラグラフの改善例
  • 文の書き方
  • 用語の使い方
  • マニュアル作成の手続き化

7.4 調査レポートの書き方

  • 調査レポートのまとめ方
  • 調査レポートの事例

7.5 小論文の書き方

  • 小論文と作文
  • 小論文のポイント
  • 入社試験の小論文
  • 小論文の事例
  • 小論文における主な問題点

7.6 論文の書き方

  • 論文作成の基本
  • 論文の構成
  • 論文作成上の留意点

7.7 論文試験問題の書き方

  • 論文問題の分析
  • 論文問題への対応方法
  • 論文を書くときのポイント
  • 合格論文を書くためのポイント
  • 論文を書くための具体的な手法
  • 論文の評価方法
  • 事例
  • 佐藤式論文試験合格の秘訣

付録

1 英文マニュアル作成から学ぶ

  • 翻訳者からの指摘
  • 英文マニュアル作成から学んだノウハウ
  • 問題点の事例

2 電子メールの書き方

  • 電子メールの活用
  • 電子メールの一般的な書き方
  • 電子メールの事例
  • 電子メールのマナー
  • 電子メール使用上の技術的な留意点

3 演習問題

4 演習問題解答例