Print Friendly, PDF & Email

研修成果

  • IT人財に必要不可欠な文書表現、文章作成のスキル等を理論と実践を通じて身につけます
  • ドキュメンテーション実習を個人ワークのみならずグループワークで実施することにより、参加者の方々と交流しながら、楽しく身に付けることができます
  • 講師、他者と様々なフィードバックにより自己のドキュメントの欠点が把握でき、改善の方策を自ら見いだしていける内容です

達成目標

  1. 技術ドキュメントとして過不足なく適切な情報量を盛り込むことができる
  2. 誤解のないシンプルで分かりやすい文章表現ができる
  3. 読み手の意識を適切な用語を使い、分かりやすい構成の文章を作成することができる

対象

入社3年目以内程度の若手IT技術者

※本講座では、以下のような報告等の文書作成の演習を行うため、事前に1つテーマを考えておいてください

 報告(例:セキュリティ対策実施状況報告)
 提案(例:タブレット端末導入のご提案)
 ご案内(例:納涼祭のご案内)
 勧誘  (例:ランニングクラブの勧誘)
 周知報告(例:昼休み消灯のお願い)

前提知識

マイクロソフトワードの基本操作に関する知識

カリキュラム

1日目

◎オリエンテーション【講義】
 研修の目的と目標

1.IT業界のドキュメントの大切さ【演習】
 (1)システム開発におけるドキュメントの役割
   ・仕様か欠陥か
   ・ 常識か非常識か
   ・プロジェクトの主な失敗
 (2)IT現場におけるドキュメントの種類
 (3)分かりづらいドキュメントとは?

2.ドキュメントの作成手順【演習】
 (1)記載事項の抽出
   ・情報の洗い出し
   ・情報どうしの関係の整理
 (2)ドキュメントの構成【演習】
   ・IT技術文書の典型的な構成
   ・理論性を高める構成
 (3)ドキュメントの表現

2日目

 3. ドキュメントの表現【演習】
 (1)日本語の特性と分かりづらさ
   ・助詞(の、より、から、で)
   ・漢字、ひらがな、カタカナ
   ・長文
   ・接続詞
   ・主語と述語の対応
   ・ねじれ文書
   ・語順と句読点
   ・対句
   ・尊敬語と謙譲語と丁寧語
   ・同音異義語
   ・二重否定
   ・受動態
   ・表記の揺れ(同義語、類義語)
   ・略語
   ・ 曖昧な表現
   ・図、表、グラフ

(2)文章表現のコツ

4.ドキュメント作成【演習】

◎総まとめ               
 ・自己成長のための指針

価格(ノンカスタマイズの場合)

講師料:30万円(税別)

テキスト代:3,000円(税別) ✕ 研修参加人数

イメージ

受講者の作成したドキュメントをレビューしていきます

この研修への感想

この研修の別バージョン

速習! IT技術者のためのドキュメンテーション(1日間)

このページを見ている方にオススメの研修

1.1 IT技術者のためのコミュニケーション

キーワード:論理思考、ノンバーバルコミュニケーション、プレゼンテーション

受講者から頂いた質問

研修受講者の文章を見ていて一番多く見かける良くない点を教えて下さい。

一文が長過ぎることです。

一文一意にすることで分かりやすい文章になります。

長すぎる文とは以下のような文です。

現在の社員が保有するスキルレベルでは、顧客が満足するサービスの提供は困難であるので、問題を解決するためには、社員の体系的なスキルアップの仕組みが必要である。

上記の文章では、現状の問題点と解決策の2つの論点(意味)が1つの文章に詰め込まれてしまっています。

これを治すために2文に分けてみます。

現在の社員が保有するスキルレベルでは、顧客が満足するサービスの提供は困難である。問題を解決するためには、社員の体系的なスキルアップの仕組みが必要である。

これで、①現状の問題点。②解決策。という具合に文が別れて言わんとすることが明確になります。

ねじれ文とはなんですか?

ねじれ文とは主語と述語が対応していない文のことです。

例えば以下のような例があります。

「私の得意なプログラミング言語は、JavaやVBAのプログラムを書いています」

私の得意なプログラミング言語は → 書いています。

と主語と述語をつないだときに意味が通じないのがねじれ文の特徴です。

日本語は主語が省略されることもあり、主語を意識しないため主語と述語の関係がねじれた文章がよく見られます。

修正例①:「私の得意な言語は、 JavaやVBA です」
修正例②:「私は、 JavaやVBAが得意です」

一番良いのは読み上げることです。私はブラウザソフトのマイクロソフトエッジの機能を使って読み上げさせてチェックしています。

よくある紛らわしい日本語表現にはどのようなものがありますか?

全てを列挙できませんが、代表的なものとして次の5点を挙げさせていただきます。

1.二重否定
 例:レスポンスタイムが遅くないわけではない
 →「レスポンスタイムが遅い」の方がすっきりしてわかりやすい。
2.受動態
  例: 管理者権限が使われる
  → 主体が明確でない。敬語と混同する可能性もある。
3.誤解されやすい条件
  例: 電話番号およびメールアドレスを入力する
 →「および」は本来「AND条件」を意味するが、「OR条件」と勘違いしている人も多い。
4.誤解されやすい条件
 例:入力フィールドは100まで
 →100が入ると解釈するのが正しいが、入らないと誤解される可能性がある。
 →また、整数以外の入力を認めるのかわからない。
5.略語
 例:RAMをつくる
 →Random Access MemoryとResponsibility Assignment Matrix(責任分担表)の2種類の解釈が可能である。

以上のようなケースが過去にありました。