From f3534d429e4ec44920b50c01403cf399ee94daf4 Mon Sep 17 00:00:00 2001 From: kyu08 <49891479+kyu08@users.noreply.github.com> Date: Mon, 3 Jun 2024 00:24:22 +0900 Subject: [PATCH] =?UTF-8?q?=E3=80=8E=E8=AA=AD=E3=81=BF=E6=89=8B=E3=81=AB?= =?UTF-8?q?=E3=81=A4=E3=81=9F=E3=82=8F=E3=82=8B=E6=96=87=E7=AB=A0=20-=20?= =?UTF-8?q?=E3=83=86=E3=82=AF=E3=83=8B=E3=82=AB=E3=83=AB=E3=83=A9=E3=82=A4?= =?UTF-8?q?=E3=83=86=E3=82=A3=E3=83=B3=E3=82=B0=E3=80=8F=E3=82=92=E8=AA=AD?= =?UTF-8?q?=E3=82=93=E3=81=A0=20=E3=82=92=E6=9B=B8=E3=81=84=E3=81=9F?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- Makefile | 6 ++- .../index.md | 4 +- content/posts/technical-writing-book/index.md | 50 +++++++++++++++++++ 3 files changed, 57 insertions(+), 3 deletions(-) create mode 100644 content/posts/technical-writing-book/index.md diff --git a/Makefile b/Makefile index 062f046..84000ca 100644 --- a/Makefile +++ b/Makefile @@ -22,4 +22,8 @@ compress-to-webp: .PHONY: lint lint: - npx textlint --fix ./content/posts/**/*.md + npx textlint ./content/posts/**/*.md + +.PHONY: lint-fix +lint-fix: + npx textlint --fix ./content/posts/**/*.md diff --git a/content/posts/ichiban-yasashii-agile-no-kyouhon/index.md b/content/posts/ichiban-yasashii-agile-no-kyouhon/index.md index 3df8468..e17b9c1 100644 --- a/content/posts/ichiban-yasashii-agile-no-kyouhon/index.md +++ b/content/posts/ichiban-yasashii-agile-no-kyouhon/index.md @@ -1,7 +1,7 @@ --- title: "『いちばんやさしいアジャイル開発の教本』 を読んだ" -tags: ["読書メモ", "アジャイル"] -keywords: ["読書メモ", "アジャイル"] +tags: ["読書ログ", "アジャイル"] +keywords: ["読書ログ", "アジャイル"] cover: "https://blog.kyu08.com/cover.png" description: "" diff --git a/content/posts/technical-writing-book/index.md b/content/posts/technical-writing-book/index.md new file mode 100644 index 0000000..a50f8d5 --- /dev/null +++ b/content/posts/technical-writing-book/index.md @@ -0,0 +1,50 @@ +--- +title: "『読み手につたわる文章 - テクニカルライティング』を読んだ" +tags: ["読書ログ"] +keywords: ["読書ログ"] + +cover: "https://blog.kyu08.com/cover.png" +description: "" +date: 2024-06-03T00:21:05+09:00 +author: "kyu08" +authorTwitter: "kyu08_" +draft: false +showFullContent: false +readingTime: true +hideComments: false +color: "" +--- + +技術書典で購入した『読み手につたわる文章 - テクニカルライティング』を読んだので学びになったトピックについて書く。 + +## 「知らない」と書けない（P14） + +> こんなふうに、自転車という対象物に対する知識があれば、パーツの位置をすべて暗記していなくても自ずと正しい自転車の絵が描けるようになります。 **必要なものは絵心やセンスではなく知識なのです。** 逆に言えば、対象物を知らないと上手な絵は描けません。 +> +> そして自分が対象物を思っていたより「知らない」ということに、我々は気付いていないことが多いのです。上手な絵は、対象物のことを知らないと描けません。それと同じように、分かりやすい実用文は、文章力のあるなし以前に **対象物をよく知らないと書けない** のです。 +> +> (中略) +> +> まずは自分が **対象物を知っているつもりでも意外と知らない** こと、そして **知らないものについて分かりやすい文章は書けない** ことを最初に知っておいてください。 + +文字にすると当たり前のことのように感じるが、ブログを書いているとよく実感する。 + + +技術的な内容であれば、当然対象を理解していないと書けないし、自分の考えでさえもいざ言語化しようと思うとなかなか筆が進まないことが多い。なのでそういうときはひたすら自分が何を言いたいのかをまず整理して理解しようとしてみている。 + +## いつまでに何をしてほしいのか書こう(P25) + +## 文書構造や文章量が適切だと分かりやすい(P26) +- 大枠から始めてだんだん細かくしていこう（P26） +- 既知から未知に繋ごう（P28） +- 一度に把握できることは7つまで（P29） + +## 再利用しやすい文章にする +並列はナカグロ（・）で書かない（P34） +リンクテキストを「こちら」にしない（P35） + + +## まとめ +具体的な知見が理由とセットで書いてあってとても勉強になった + +チームで仕事をする上で認知負荷を下げる工夫の重要性を日々感じるのでこれからも意識的に情報収集していきたい。