わかりやすい技術文書の作成術

技術文書に書くべき文章は、文学や他の実用文書とは明らかに異なる。基本的な文章作成の考え方から技術者として必要な文書の作成方法まで、実例を挙げながら学習する。講師はプラントエンジニアリング技術者として、設計作業や業務連携、伝承技術集成、技術教育業務を担当してきた。 顧客向け、製作者向け、社内向け、そして業界向けの文書作成と添削指導を行ってきた経験に基づいて分かりやすく説明する。 　本講では、まず、文章書きの基本的なスキルはどのようなもので、どう力を付けるかを述べる。その上で、打合せ議事録、トラブル報告書、実験報告書、各種の提案書、宣伝資料、謝罪文など、仕事で用いられる内部文書に加え、論文、雑誌記事、取り扱い説明書、納入仕様書、購入仕様書など外部に提出する技術資料を念頭に置いて文章の書き方を示す。 　受講生には、多くの添削事例を提示しながら、どうすればより良い文章を書けるかを一緒に考えていただく。また、理解を深めるために文章作成および間違い探しの演習を織り込む。

1. 文書作成の心構え
   1. 技術文章と文学の比較
   2. 気ままに書いた文章
   3. 読み手を特定してイメージ
   4. 読み手の気持ち
   5. 読み手に信頼感を与える文書
      1. 客観性と気持ちの伝達
      2. 誠実と尊大
      3. 品格のある文章
2. 技術文章の基本
   1. 基礎的事項
      1. 必要十分を基本とする文書
      2. 間違いなく伝える文書
      3. 断定しない表現の使い方
      4. 難しい概念の図示
      5. 実例を提示した方が良いケース
      6. 正しい比喩的表現の使い方
      7. 同じ言葉の繰り返し
      8. 文章内の参照元
      9. 箇条書きの利用
      10. 誠実な態度での強調
      11. 説明 (プレゼン) を意識
      12. 報告文の感想の書き方
   2. 推論のよりどころ
      1. 三段論法
      2. 弁証法 (正反合)
      3. 帰納法と演繹 (えんえき) 法
      4. 仮定と実証の繰り返し
   3. 文書の構造
      1. 文章の構造化
      2. 定型的な項目立て
   4. 論述の進め方
      1. 結論の置き方
      2. 起承転結
      3. 序論・本論・結論
      4. 序破急
      5. 内容記述の流れの原則
      6. 重要性を基にした順序
      7. 業務文書の型式
   5. 気の利いた文章
3. 文の作成
   1. 正確、厳密に書く
      1. 形容の程度
      2. 「〇〇など」の使い方
      3. 「〇〇や〇〇」の使い方
      4. 接続語による関係の明示
      5. 難解な文と平易な文
      6. 動作の主語
      7. 主語と述語の位置関係
      8. 述語のまとめ
      9. 「こそあど」言葉
      10. 専門用語、略語の説明
      11. 文の分割
      12. 重ね言葉
      13. 時制の表現
      14. 体言止め
4. 2 文法上の誤りをなくす
   1. 主語と述語の合わせ方
   2. 修飾語とその対象
   3. 語順と倒置法
1. 表現するための他の方法
   1. 類語、反対語、対義語
   2. 二重否定
   3. 対偶による表現
2. ものごとの並べ方
3. 解説的な定義の方法
4. 敬語の使い方
5. 用字用語の使い方
   1. 使う言葉を選ぶ
      1. 使えない話し言葉とは
      2. 文語的な用語
      3. 理由の「より」と「から」
      4. 「～的」、「～性」、「～化」
      5. 人の言葉・表現を鵜呑みにしない
      6. 「ら抜き」、「さ入れ」、「れ足す」、「い抜き」
      7. 専門用語の統一
      8. 差別 (禁止) 用語
      9. 低俗表現
      10. 方言で間違えやすい言葉
      11. 使わない方がよい文学表現
      12. 商品名と一般名
   2. 顧客に関する名称
      1. 会社名
      2. 株式会社など
      3. 企業などの略称例
      4. 御社と貴社、弊社と当社
      5. 自分と相手の呼称
      6. 殿と様
   3. 時の表現と「とき」
   4. 用字
      1. 学習すべき漢字の変化
      2. 漢字力はどれほど必要か
      3. 一般の用字用語の手引
   5. 送り仮名
   6. 単位の使い方と表記法
   7. 格助詞「の」の多様な意味
6. 文章作成の手順
   1. 実際の文章作成の流れ
      1. 敬体 (ですます) か常体 (である) か
      2. リード (概要) 文
      3. WORDの「スタイル」による構造化
      4. 文書の目的と価値
   2. 著述の流れ
      1. 書くべき事項の列挙
      2. 文章の流れと見出し
      3. 見出しの並べ替え
      4. 内容を少し記述を
      5. 順序とタイトルの修正
      6. 書き進め
      7. 見出し、順序は随時並べ替え
      8. 不要な個所の削除
      9. 推敲
   3. 読点「、」の適切な打ち方
   4. 文章の修正
      1. チェックリスト
      2. 技術用語の同音異義語
      3. 抜けている項目の探し方
      4. ソフトウェアの文書校正機能の利用法
   5. 文の最終チェック
      1. 「、」を検索
      2. 「。」を検索
      3. 改行マークの検索方法
      4. 全体を通して読み返す
7. 技術文書作成の実践
   1. 技術関連の文書
      1. 文書の種類
      2. 文書の保存
   2. 打合せ議事録
      1. 打合せ議事録の失敗
      2. 記録の主観性と客観性
      3. 記録で明確にしておくべきこと
      4. 記録する方法と注意点
      5. 記録の表現例
      6. 承認、フォローと再配付
      7. 逐一記録 (録音複製)
   3. 取扱説明書、操作基準書
      1. 留意事項
      2. 操作基準書の重要な項目
   4. トラブル報告書
   5. 調査報告書
   6. 実験報告書
   7. 学術論文・技術論文
   8. 稟議書
   9. 特許明細書
      1. 特許のアイデア提出書
      2. 特許明細書
      3. 特許共同申請契約書
      4. 稟議書
   10. 新規事業提案書
   11. 公的補助金申請書
   12. 納入 (見積・受注) 仕様書
   13. 購入 (引合・発注) 仕様書
   14. 機器仕様リスト
   15. 各種設計図の補足書
   16. 出張報告書
8. 文章作成の勉強法
   • 演習1 顧客への連絡文章の作成実習と模範文解説
   • 演習2 取り扱い説明書の作成実習と解説
   • 演習3 実際の添削例からの間違い探し演習と解説
• 質疑応答