Skip to content

Commit

Permalink
Merge pull request #200 from h-yoshikawa44/feature/199_fix-post
Browse files Browse the repository at this point in the history
記事修正:テクニカルライティング本の記事に第2版情報追加、JSConf JP 2024記事のYouTubeリンクを改善
  • Loading branch information
h-yoshikawa44 authored Dec 31, 2024
2 parents 08c341f + d883ac4 commit 14aa40b
Show file tree
Hide file tree
Showing 4 changed files with 91 additions and 4 deletions.
6 changes: 6 additions & 0 deletions generated/ogp/2023.json
Original file line number Diff line number Diff line change
Expand Up @@ -741,6 +741,12 @@
"description": "生産性が向上し、相手に伝わる論理的な技術文書の書き方\n\n日本では、「文書は論理的かつ簡潔に記述する」という、当たり前のテクニックを学ぶ機会があまりありません。\nそこで本書では、忙しい技術者の方でも「テクニカルライティング」を通じて、相手に伝わる技術文書を効率よく\n書けるようになるテクニックを多数紹介していきます。\nユーザーマニュアルや障害報告書、提案書といった実務直結の文例を多数掲載しているので、すぐに業務に役立てることが可能です。\n新人~中堅の技術者の方だけでなく、管理職の方も添削指導のお手本としてご利用いただける内容です。\n\n\n【目次】\n第1章 ロジカルライティング×テクニカルライティング活用の基礎知識\n第2章 わかりやすく、簡潔な文章を書くテクニック\n第3章 読み手に伝わる文章を書くテクニック\n第4章 読みやすさを高める文書フォーマット〜表現・表記のルール〜\n第5章 実践編 ユーザーマニュアル・取扱説明書\n第6章 実践編 提案書\n第7章 実践編 障害報告書\n第8章 実践編 社外メール文",
"image": "https://www.shoeisha.co.jp/static/splus/1660/meta/9784798157191.jpg",
"favicon": "https://www.google.com/s2/favicons?sz=256&domain=https://www.shoeisha.co.jp"
},
"https://www.shoeisha.co.jp/book/detail/9784798188423": {
"title": "技術者のためのテクニカルライティング入門講座 第2版 | 翔泳社",
"description": "\n情報をわかりやすく伝えるために必要なのは、センスではなく技術!\n生産性が向上し、相手に伝わる論理的な技術文書の書き方\n\n日本では、「文章は論理的かつ簡潔に記述する」というテクニックを学ぶ機会があまりありません。 \nそこで本書では、忙しい技術者の方でも「テクニカルライティング」を通じて、相手に伝わる技術文書を効率よく書けるようになるテクニックを多数紹介していきます。\nユーザーマニュアルや障害報告書、提案書といった実務直結の例を多数紹介しているため、すぐに業務に役立てられます。\n豊富な文例とともに章末には実践的な「演習」を掲載しているので、新人~中堅の技術者の方だけでなく、管理職の方も添削指導のお手本としてご利用いただける内容です。\nこの第2版では、生成AIを使った効率的な文章の書き方や校正、要約の仕方を加筆しています。生成AIを利用する際の注意点も紹介しているので、機密事項を扱うエンジニアの方には必須の内容となっています。\n【こんな方におススメします】\n・各種ドキュメントを書くのに苦手意識のある方\n・取引先や上司から、資料がわかりにくいと指摘されたことのある方\n・生成AIの利用に不安のある方\n\n【目次】\n第1章 ロジカルライティング×テクニカルライティング活用の基礎知識\n第2章 わかりやすく、簡潔な文章を書くテクニック\n第3章 読み手に伝わる文章を書くテクニック\n第4章 読みやすさを高める文書フォーマット~表現・表記のルール~\n第5章 実践編 ユーザーマニュアル・取扱説明書\n第6章 実践編 提案書\n第7章 実践編 障害報告書\n第8章 実践編 社外メール文\n第9章 生成AIの技術文書への活用\n【著者プロフィール】\n髙橋 慈子(たかはし しげこ)\n東京農工大学卒。技術系出版社を経て、テクニカルライターとしてフリーランスで取扱説明書の作成に関わる。1988年テクニカルコミュニケーションの専門会社として、株式会社ハーティネスを設立。同代表取締役。企業の取扱説明書やマニュアル制作のコンサルティングや人材育成に関わる。テクニカルライティング研修のほか、ビジネス文書研修の企画や実施、各種セミナーで文章の書き方指導も行っている。",
"image": "https://www.shoeisha.co.jp/static/book/og_image/9784798188423.jpg",
"favicon": "https://www.google.com/s2/favicons?sz=256&domain=https://www.shoeisha.co.jp"
}
},
"2023-02-11-developers-summit-2023": {
Expand Down
24 changes: 24 additions & 0 deletions generated/ogp/2024.json
Original file line number Diff line number Diff line change
Expand Up @@ -337,6 +337,30 @@
"description": "作成した動画を友だち、家族、世界中の人たちと共有",
"image": "https://yt3.googleusercontent.com/ytc/AIdro_m4ohdTwVIwcCyC7ytC30bfu8rSA1b_2VhEmzXIPEr-yQ=s900-c-k-c0x00ffffff-no-rj",
"favicon": "https://www.google.com/s2/favicons?sz=256&domain=https://www.youtube.com"
},
"https://www.youtube.com/watch?v=2BXwigWGjWQ": {
"title": "JSConf JP 2024 トラックB",
"description": "https://jsconf.jp/2024/jsconf.jp is a JavaScript festival in Japan powered by Japan Node.js Association. This is the fifth time event of jsconf in Japan. We ...",
"image": "https://i.ytimg.com/vi/2BXwigWGjWQ/maxresdefault.jpg?sqp=-oaymwEmCIAKENAF8quKqQMa8AEB-AH-CYAC0AWKAgwIABABGGQgZChkMA8=&rs=AOn4CLCu3_r2KVFHUE9Ygi2kn6F2l-VlvA",
"favicon": "https://www.google.com/s2/favicons?sz=256&domain=https://www.youtube.com"
},
"https://www.youtube.com/watch?v=5Wt0r5vHOwQ": {
"title": "JSConf JP 2024 トラックD",
"description": "https://jsconf.jp/2024/jsconf.jp is a JavaScript festival in Japan powered by Japan Node.js Association. This is the fifth time event of jsconf in Japan. We ...",
"image": "https://i.ytimg.com/vi/5Wt0r5vHOwQ/maxresdefault.jpg?sqp=-oaymwEmCIAKENAF8quKqQMa8AEB-AH-CYAC0AWKAgwIABABGBMgTyh_MA8=&rs=AOn4CLAkOWfg8f65EU3891KDJlcbwbKirg",
"favicon": "https://www.google.com/s2/favicons?sz=256&domain=https://www.youtube.com"
},
"https://www.youtube.com/watch?v=E3yTtaGr7V8": {
"title": "JSConf JP 2024 トラックC",
"description": "https://jsconf.jp/2024/jsconf.jp is a JavaScript festival in Japan powered by Japan Node.js Association. This is the fifth time event of jsconf in Japan. We ...",
"image": "https://i.ytimg.com/vi/E3yTtaGr7V8/maxresdefault.jpg?sqp=-oaymwEmCIAKENAF8quKqQMa8AEB-AH-CYAC0AWKAgwIABABGE0gSihlMA8=&rs=AOn4CLAJZCVAxTMdLivK9elHp0ZSSm1s7A",
"favicon": "https://www.google.com/s2/favicons?sz=256&domain=https://www.youtube.com"
},
"https://www.youtube.com/watch?v=ew1zmA7y9q8": {
"title": "JSConf JP 2024 トラックA",
"description": "https://jsconf.jp/2024/jsconf.jp is a JavaScript festival in Japan powered by Japan Node.js Association. This is the fifth time event of jsconf in Japan. We ...",
"image": "https://i.ytimg.com/vi/ew1zmA7y9q8/maxresdefault.jpg?sqp=-oaymwEmCIAKENAF8quKqQMa8AEB-AH-CYAC0AWKAgwIABABGGUgZShlMA8=&rs=AOn4CLDu7u3EVquRHqOuQ5JVUG3-s1MO1A",
"favicon": "https://www.google.com/s2/favicons?sz=256&domain=https://www.youtube.com"
}
},
"2024-08-25-frontend-conf-hokkaido-2024": {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: "技術文書を書く方に送る、書籍「技術者のためのテクニカルライティング入門講座」"
description: "書籍「技術者のためのテクニカルライティング入門講座」と、さらなるテクニカルライティングの世界の紹介"
pubDate: "2023-03-25"
updatedDate: "2023-11-25"
updatedDate: "2024-12-31"
category: "develop"
tags: ["テクニカルライティング"]
---
Expand Down Expand Up @@ -33,6 +33,10 @@ import OG from "@/components/OG.astro"
書籍が発売されたのは2018年11月19日。
当記事の執筆時点からは約5年前になりますが、今でも十分通用する内容になっていると個人的に思いました。

**※2024/12/31追記**
2024/12/18に第2版が出版されました! 主に生成 AI に関する章が増えているようです。
<OG url="https://www.shoeisha.co.jp/book/detail/9784798188423" />

### 紹介したいと思った背景
(私事なので興味ない方はすっ飛ばしてもらって大丈夫です)

Expand Down
Loading

0 comments on commit 14aa40b

Please sign in to comment.