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技術者のためのドキュメンテーション研修
受講者の作成したドキュメントをレビューしていきます

IT技術者のためのドキュメンテーションへの感想

この研修の別バージョン

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

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

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

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

IT技術者のためのドキュメンテーション研修で受講者から頂いた質問

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

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

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

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

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

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

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

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

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

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

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

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

修正例としては以下のようなものがあります。

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

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

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

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

1.二重否定
 例:レスポンスタイムが遅くないわけではない
 →「レスポンスタイムが遅い」の方がすっきりしてわかりやすい。


2.受動態
  例: 管理者権限が使われる
  → 主体が明確でない。敬語と混同する可能性もある。


3.誤解されやすい条件
  例: 電話番号およびメールアドレスを入力する
 →「および」は本来「AND条件」を意味するが、「OR条件」と勘違いしている人も多い。


4.誤解されやすい条件
 例:入力フィールドは100まで
 →100が入ると解釈するのが正しいが、入らないと誤解される可能性がある。
 →また、整数以外の入力を認めるのかわからない。


5.略語
 例:RAMをつくる
 →Random Access MemoryとResponsibility Assignment Matrix(責任分担表)の2種類の解釈が可能である。

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

「です・ます」調で文章を書いたとき語尾が単調になるのが気になります。

確かに以下の例文のように文末に「す」の音が4行以上に渡って続くと単調に感じるように思われます。

私はシステムエンジニアです。
普段はシステム開発プロジェクトに所属しています。
大変なのは納期に追われたときです。
それでもやりがいのある仕事です。

単調でなくすには3回に1回は「す」音以外で文を終えるようにすると良いでしょう。

次のような方法があります。

1.過去形の「た」で終える。

私はシステムエンジニアです。
普段はシステム開発プロジェクトに所属しています。
大変なのは納期に追われたときでした。
それでもやりがいのある仕事です。

2.否定形にして「ん」で終える。

私はシステムエンジニアです。
普段はシステム開発プロジェクトに所属しています。
納期に追われたときは大変としか言いようがありません。
それでもやりがいのある仕事です。

3.疑問形にして「か」や「う」で終える。

私はシステムエンジニアです。
普段はシステム開発プロジェクトに所属しています。
納期に追われたときは以上に大変なことはあるでしょうか。
それでもやりがいのある仕事です。

4.「とき」、「こと」、「もの」で終える。

私はシステムエンジニアです。
普段はシステム開発プロジェクトに所属しています。
大変なのは、何と言っても納期に追われたとき。
それでもやりがいのある仕事です。

5.体言止め

私はシステムエンジニアです。
普段はシステム開発プロジェクトに所属しています。
大変なのは納期厳守。
それでもやりがいのある仕事です。

読点「、」の使い方にはどのようなものがありますか?

読点は、その名の通り文章を読みやすくするためのものです。

次のような使い方があります。

1.漢字やひらがなを区切る

悪い例:システム開発部長田渕さんが出席しました。

良い例:システム開発部長、田渕さんが出席しました。

悪い例:ここではきものをぬいでください。

良い例:ここで、はきものをぬいでください。

2.主語と述語の係り受けを明確化する

悪い例:最近取引が始まったA社のシステム開発部長に新しく選任された田渕さんが会議に出席しました。

良い例: 最近取引が始まったA社のシステム開発部長に新しく選任された田渕さんが、会議に出席しました。

3.読点の前の語を強調する

悪い例:しかし一言もシステムの不具合については発言しませんでした。

良い例: しかし、一言もシステムの不具合については発言しませんでした。

4.名詞を列挙するとき

悪い例:私が得意なプログラミング言語はJavaとJavascriptとPythonです。

良い例: 私が得意なプログラミング言語はJavaと、Javascriptと、Pythonです。

箇条書きの最後に句点「。」を付けるべきですか?

箇条書きが名詞で終わるなら付けない、複数の名詞からなる文章なら付ける

個人的にはそうしています。

根拠は法律の条文の書き方です。

例えば、以下は民法111条の引用です。

(代理権の消滅事由)
第百十一条 代理権は、次に掲げる事由によって消滅する。
一 本人の死亡
二 代理人の死亡又は代理人が破産手続開始の決定若しくは後見開始の審判を受けたこと。

以上のように、「死亡」という名詞で終わっている場合は句点はなく、「 代理人の死亡又は代理人が破産手続開始の決定若しくは後見開始の審判を受けたこと 」という文章には句点があります。

さらに、個人的な好みですが、上記のように1つの箇条書きに句点があったりなかったりするのは避けるようにしています。

ドキュメント作成時に有効なツールがあれば教えてください

文章校正」というツールがあります。

オンライン上のツールで文章を入力するか、URLを入れることで文章を構成してくれるツールです。

以下のような項目をチェックしてくれます。

表記・表現の間違い、不適切な表現の検出
… 誤変換、誤用、使用注意語、不快語 (使用不適切な語や隠語など)、機種依存文字または拡張文字、外国地名、固有名詞、人名、ら抜き言葉
わかりやすい表記にするための提案
… 当て字、表外漢字、用字
文章をよりよくするための提案
… 用語言い換え、二重否定、助詞不足の可能性あり、冗長表現、略語

https://so-zou.jp/web-app/text/proofreading/

英語の場合は「Grammarly」のようにリアルタイムで記述中の文章を構成してくれるツールがあります。

やがて日本語にも同様のサービスができるかもしれませんね。

Microsoft Wordを使っていてスタイルから「見出し」を選択したところその見出しの左側に「・」がついてしまいました。どうしたら消せますか?

・はスタイルが当たっていることを表す記号です。

印刷はされませんので安心してそのまま作業をお続けください。