Upgrade to Pro — share decks privately, control downloads, hide ads and more …

美しい文章 / Beautiful Writings

美しい文章 / Beautiful Writings

エンジニアが技術書を執筆する際のテクニックや、気をつけるべきポイントをまとめました

Akira Morikawa

January 18, 2019
Tweet

More Decks by Akira Morikawa

Other Decks in Education

Transcript

  1. 16 ペルソナを作る なぜ重要なのか • 相手の年齢や性別によって理解しやすいコンテキストが違う • 相手のスキルによって説明のボリュームが違う ◦ わからないだろうことは丁寧に説明する ◦

    わかるだろうことは用語のみを提示する • 相手にどんなことを促したいかを考える必要がある ◦ 写経してほしいのか? ◦ 読み解いてほしいのか? ◦ リファレンスとして使われたいのか? • 読解によって得られるものは何かを明確にする
  2. 20 キーワード ElasticSearch, 全文検索 主題 ElasticSearchを用いた、全文検索エンジンの構築手順を紹介する 前提条件 (誰に?) • ElasticSearchを使ったことがない若手エンジニア

    • 商品DBは構築したことがあるが、全文検索の導入実績がない • 類似製品を比較検討したことがない 背景 (何で?) • 全文検索エンジンは高速であり、その素晴らしさを伝えたい • 設計や構築手順が独特であり難しい ゴール • ElasticSearchを使った全文検索エンジンを自身で構築できるようになる • 事例を通じて組み込むべき箇所を想像でき、読了後に実践する 主軸のサンプル
  3. 27 パラグラフライティング パラグラフのルール • 各パラグラフの話題は1つにする • 話題の要約をパラグラフの先頭に配置する(トピックセンテンス) ◦ トピックセンテンスだけであらすじが理解できる •

    各パラグラフ内には話題の補足文のみを配置する • 文の接続詞を適切に配置する パラグラフライティングの作法-書き手にもメリットのある文配置ルール
  4. 30 論理的推論法 帰納法 induction • 複数の事象をもとに1つの結論を導き出す。 • 経験論的な思考から認知する。 • フランシス・ベーコン(イギリスの哲学者)が提唱。

    • 「規則」を規定することを意味する。 ◦ 「前提条件」の次に起こる「結論」の諸事例の一部から「規則」を学ぶ。 • 結論に導くための材料(事象)を多く集めるほど説得力が増す。
  5. 32 論理的推論法 演繹法 deduction • 一般的な前提条件から、より個別の結論を導き出す。 • 人間の持つ普遍的な理性を原点として認知する。 • ルネ・デカルト(フランスの哲学者)が提唱した。

    • 「結論」を規定することを意味する。 ◦ 「規則」と「前提条件」を用いて「結論」を導く。 • 代表的な手法として 三段論法 がある。
  6. 33 論理的推論法 三段論法 syllogism 三段論法では、以下の三文を基本として論述する。 1. 大前提 誰もが当たり前に認識している事実を記載する。 例)「全ての人間は死すべきものである。」 2.

    小前提 当事者でないと知らない事実を記載する。 例)「ソクラテスは人間である。」 3. 結論 これらの前提条件から結論を導出する。 例)「ゆえにソクラテスは死すべきものである。」
  7. 35 論理的推論法 アブダクション abduction • 結果から原因を推測(仮説形成)し、観測事実に対して説明を導き出す。 • チャールズ・パース(アメリカの哲学者)が提唱した。 ◦ アリストテレスの論理学をもとにして作成されている。

    • 過去事象についての「前提条件」を推定することを意味する。 ◦ 「ある前提条件が結論を説明することができるだろう」ということを裏づける。 • 何よりも想像力が重要になる。
  8. 38 論理的推論法 まとめ • 事実と意見の違いを意識する。 ◦ 事実と意見を明確にわける。 ◦ 意見がどのような事実から支えられているか意識する。 ◦

    伝わり手にとって 結論の検証 を容易にする。 • MECEを意識する。 ◦ MECEに基づいて事実や意見を細分化する。(※ロジックツリー等を使う) ◦ 各項目を細分化することにより、問題の本質や解決策を絞り込める。 ◦ 意見が導き出される過程を明らかにする。 • 結論の正確性を担保し、論理が飛躍しないことを意識する。
  9. 41 文章構成法 PREP法 • 構成方法は以下の通り。 ◦ Point(要点) … 要点を簡潔に伝える ◦

    Reason(理由) … 要点に対する理由を説明する ◦ Example(具体例) … 理由に対する具体例を挙げる ◦ Point(要点) … 要点を再度言葉をかえてまとめる • 要点の他に説明と例をまじえる事でより理解が深まる。 • 教本やセミナーなどの教育的表現において特に有効。
  10. 43 文章構成法 SDS法 • 構成方法は以下の通り。 ◦ Summary(要約)… 要約を簡潔に伝える ◦ Detail(詳細)

    … 要約についてより詳しく伝える ◦ Summary(要約)… 要約を再度言葉をかえて伝える • 日記や報告など、用途を選ばず汎用的に使える。
  11. 45 文章構成法 DESC法 • 構成方法は以下の通り。 ◦ Describe(描写) … 状況を客観的に描写する ◦

    Express(表現) … 主観的な意見や問題点を表現する ◦ Suggest(提案) … 解決法を提案する ◦ Consequence(結論) … 提案によりどのような結果になるかを結論づける • 人に何かを承認させたい時に使う。 • 問題点を提起してから解決法を伝える事でより提案力が増す。
  12. 48 主張 私は(______)の(______)について(_____)と考えます。 根拠 なぜなら(______)だからです。 定説 一般に(______)とされています。 権威付け (______)によれば(______)とされています。 具体例

    たとえば(______)です。 事例 かつて(______)ということがありました。 比喩 まるで(______)のようなものです。 疑問 たしかに(______)という面はあります。 疑問への反論 しかし(______)ではないでしょうか。 主張の繰返し それゆえ(______)すべきなのです。 イシハラ式ラクラク作文シート | © 読書猿Classic (文章テンプレート例)
  13. 51 テクニックとヒント 接続詞「が」に注意する 接続詞「が」には逆接と順接が存在するが、使い方としては逆接が正しい。 • 逆接 … 内容が逆の文章を繋ぐ • 順接

    … 内容が同じ文章を繋ぐ 例1)「今日は晴れですが、明日は雨でしょう」 例2)「今日は晴れですが、明日も晴れでしょう」
  14. 57 テクニックとヒント 漢字を開く 一部の漢字をひらがなにすることで、読みやすくなる。 漢字 ひらがな 殆ど ほとんど 下さい ください

    更に さらに 事 こと 物 もの 漢字 ひらがな 出来る できる 良い よい 後で あとで 丁度 ちょうど 何でも なんでも
  15. 61 テクニックとヒント 表記揺れや文字誤りに注意する 特に注意すべき代表例は以下のとおり。 • 漢字とひらがなの表記揺れ(例:時/とき、例えば/たとえば) • 末尾にある長音の表記揺れ(例:コンピューター/コンピュータ、ユーザー/ユーザ) ◦ 3文字以上の場合は末尾の長音をトルのが一般的

    • 送りがなの表記揺れ(例:行う/行なう) • 名詞形と動詞形の送りがな(例:申し込む/申込、受け付ける/受付) • 同音異義語を正しく使う(例:計る/測る、保証/保障) • 同一接続詞を繰り返さない(例:末尾の長音の表記揺れ) • ら抜き言葉を使わない(例:見れる/見られる、食べれる/食べられる) • さ入れ言葉を使わない(例:見させていただく/見せていただく)
  16. 66 テクニックとヒント まとめ • 接続詞や助詞など、正しい日本語 を意識しよう • あいまいな表現を避け、できるだけ 肯定形 を意識しよう

    • 細かな 表記揺れ に注意を払おう • 必要に応じて「用語辞書」を作っておこう • 発音しながら 読み返して みよう • 以下の記事がおすすめ ◦ 文章をパワーアップしよう ◦ 今日から使える「文章作成力」 ◦ 論文の文章を推敲するための12の方法 ◦ 上手な文章を書くための改善ポイント
  17. 72 #35a16b #ff9900 #4b4b4b #4b4b4b 美しい文章 #35a16b あいうえおあいうえおあいうえお #ff9900 あいうえおあいうえおあいうえお

    #4b4b4b あいうえおあいうえおあいうえお ※この資料は カラーユニバーサルデザイン に基づいて配色されています