テクニカルライティング

概要 先日から開催されている技術書典 16で購入した表題の本について、感想を書きました。 この記事は誰向けの内容か 本書に興味を持っているが、購入を悩んでいる人 本書を購入して他人の感想が気になった人 この記事は誰向けの内容ではないか 本書について興味がない人 この記事を読んだ後にどんな状態になるか 本書で学べることが分かるはず この本を読もうと思ったきっかけ 技術書典 16 のおすすめ本をツイッターなどで探していて、目についたのがきっかけになります。 普段の業務はリモートワークのため、以下のように文章を書く機会がとても多いです。 slackでの報告・連絡・相談 社内Wikiに手順書やナレッジ…

こんにちは。techtekt編集部です。 パーソルキャリアのエンジニアリング業務を積極的に発信し、リアルに、わかりやすくユーザーの皆様へお届けしたエンジニアやデータサイエンティストなどを称える、“techtekt テクニカルライティングアワード”。2020年からスタートし、データサイエンティストや新規サービス開発のエンジニアが歴代受賞してきました。 さて、2022年度は前年度に比べてエンジニア寄稿記事のPV数が約3倍に増加し、エンジニアによるエンジニアのための技術記事が多く読まれた1年でもありました。年々本アワードの選定の難易度が高まる中、栄えある2022年度のtechtekt テクニカルライ…

以前に読了したのですが、久しぶりに参照しました。 文法やパンクチュエーションについて確認したいときに便利です！ 目次も索引も詳しいので、確認したいところを探しやすかったです。 テクニカルライティング全般について学べます。 以前にも感想を書きました（WordPressから移行した記事なので改行が少し変になっていますが読むのに問題はないと思います）。 translators-life.com NASAに学ぶ 英語論文・レポートの書き方 －NASA SP-7084テクニカルライティング－ 今日は原文に間違いが多いものを翻訳していてちょっとイライラしていたのですが、自分も間違うことはあるし、正しい文章…

ついウッカリしては本当ですか？ ほとんどのテクニカルライターさんは、基本を知っています。短く書く、一文一義、手順と結果を分ける、箇条書きなどです。 それなのに実際のライティングで実行できない人が大勢います（汗）。不思議ですね、、、 そんな人は言います。 知ってはいたんですが、ついウッカリして！ 残念ですが、その場しのぎの言い訳でしかありません。そんな人の多くが、ずっと言い続けてます。 知ってはいたんですが、ついウッカリして！ そんな人に質問です、あなたは考えるとできますか？ 上司から指摘を受けて直ぐに書き直すことができるのであれば「はい」です。できないのであれば、知らないからできないのです。勉…

２３日が卒業研究発表会です。そして今週末がその発表用要旨（A4版１ページ）の〆切になっています。 この要旨は指導教員が指導するわけですが、まともに技術文章を書いたことがある人はそれほど多くはないので、そもそも何をどういう順番で書いていくかで悩むわけです。 論文の書き方の本は世の中にたくさん出版されていますし図書館にもたくさんあるし、もちろんゼミ室にもたくさん置いてあるので読んでくれればいいのですが。。。なかなか読む人はいない。 で、とりあえずいつも指導していることをブログに書いてこれをポインティングするわけですが、これもあまりみてもらえない。。。という状況で。結局、１つ１つ指導していくしかない…

先日、社内でテクニカルライティングに関しての勉強会が開催されました。 リブセンス社内の多数のエンジニアが参加し、大盛況となりました。この記事ではそんな勉強会の模様を紹介します。 概要 開催の経緯 エンジニアブログの記事を自信を持って書いてもらえるようになってほしい 良い文章とはどんな文章かの共通認識を作りしたい 講義の内容 テクニカルライティングの基本的な考え方を知る 伝える情報を整理する アウトラインを作る トピック単位で文章構成の骨組みを作る わかりやすく、簡潔な文章で書く 質疑応答 最後に 概要 今回の勉強会では、外部より仲田 尚央さん(@naoh_nak)に講師をお願いしました。テクニ…

こんにちは、開発本部データサイエンティストの山口です。 製品やサービスのユーザー向けにコンテンツを制作している方は、一度は以下のように考えたことがあるのではないでしょうか。 「このコンテンツは本当に効果があったのだろうか？」と。 ここでは「コンテンツ」を「特定の認識・行動を、ユーザーに促す情報のまとまり（テキスト、音声、動画など）」を指すものとします。また、コンテンツの「効果」は「コンテンツの狙い通りにユーザーの行動が変化したこと」を意味するものとします。 多くの場合、コンテンツの視聴回数だけではユーザーの行動の変化までを知ることはできません。また、ユーザーの行動に変化があることがわかったとし…

翻訳祭プログラム紹介、連休中も続きます^^; 今日はその6。 ・10/25（金）13:30～15:00・中村哲三さん（ASD-STE100 STE Maintenence Group）・「情報を「つかう」「つたえる」視点で考えるAI翻訳活用法」 www.33jtffestival2024.com 哲三さん、なんでプロフィール欄が英語なんだろ？ この紹介だけだと、ご存じない方にはよく分からないかもしれませんね。ひと言でいうと、英語と日本語の両方のテクニカルライティングのプロです。以前は、JTFとかテクニカルコミュニケーター協会（JTCA）の講演などにたびたびご登壇なさっており、私も、何度となく同…

はじめに こんにちは、Tochiです。 第2章~第20章に引き続き、今日も読み進めていきます！ 今日は第21章の「Deside What Matters」ついて考えていきたいと思います。 第2章まとめ 第3章まとめ 第4章まとめ 第5章まとめ 第6章まとめ 第7章まとめ 第8章まとめ 第9章まとめ 第10章まとめ 第11章まとめ 第12章まとめ 第13章まとめ 第14章まとめ 第15章まとめ 第16章まとめ 第17章まとめ 第18章まとめ 第19章まとめ 第20章まとめ https://amzn.asia/d/7tUC5KQ はじめに 21章 何が重要かを決める 21.1 何が重要かを決めるに…

はじめに 人工知能（AI）やIoTの発展と共に、私たちの生活や産業界に革命をもたらしているロボット技術。その最前線で活躍するのが、ロボティクスエンジニアです。彼らは、人間の想像力と技術力を結集し、夢のような機械を現実のものとしています。 ロボティクスエンジニアとは、ロボットの設計、開発、製造、メンテナンスに携わる専門家です。機械工学、電気工学、コンピュータサイエンスなど、多岐にわたる知識と技術を駆使して、産業用ロボットから家庭用ロボット、さらには医療や宇宙開発で使用される高度なロボットまで、様々な分野で革新的なソリューションを生み出しています。 この職業は、技術の進歩と共に急速に重要性を増して…

開発本部 People Experienceチーム オンボーディング担当の久宗(@tignyax)です。 2024年もエンジニア新人研修を行いましたので、軽い紹介と、講義資料および一部講義動画を公開いたします。 2024年エンジニア新人研修の講義資料公開 2024年のエンジニア研修について コンセプト 今年のエンジニア研修のコンセプトは以下です。 （去年と同様です） 『新入社員メンバーに、"自信を持ってチームにジョインできた!" 』 コンセプトを実感できるように、以下のことを学んだり体験してもらえるようなエンジニア研修を設計していきました。 開発・運用本部のチーム/人や体制、風土/文化 これか…

こんにちは。NEO(x) の宮脇（@catshun_）です。 本記事はなつやすみ特集として、『LLMプロダクト開発のことはじめ』をテーマとした 5分で読める コラムを紹介します🌻 といいつつ今回は文量が多くなってしまいました...。 ゆるく書くつもりなので、役に立つかどうかは分かりません 🐈

（8/2）ひとまず100点選書。第一弾の選書なので推薦本には頼らず。蔵書とアマゾンのブックリスト、これまでの読書経験と知識を駆使して、読みたい本を直感で選んだ。 今のところ順番はランダムだ。3500の選書リストが完成するまでには適切な分類法を見つけようと思う。その際、選書やリスト作成におけるルールも付記する（表紙画像は載せない、アマゾンや出版社ページへのリンクは貼らない等）。 （8/3）200点選書。 （8/4）300点選書。 （8/5）400点選書。そろそろ分類しないとね。日本十進分類法を参考にする予定。 （8/9）500点選書。 （8/10）600点選書。 （8/11）700点選書。 （8…

初心者からちゃんとしたプロになる Illustrator基礎入門 改訂2版 「初心者からちゃんとしたプロになる Illustrator基礎入門 改訂2版」の特長 「初心者からちゃんとしたプロになる Illustrator基礎入門 改訂2版」対象読者 「初心者からちゃんとしたプロになる Illustrator基礎入門 改訂2版」の内容 「初心者からちゃんとしたプロになる Illustrator基礎入門 改訂2版」Amazonでの購入はこちら 「初心者からちゃんとしたプロになる Illustrator基礎入門 改訂2版」楽天市場での購入はこちら 初心者からちゃんとしたプロになる Illustrat…

こんにちは！夏ですね。@kimukei です。 今回は、弊プロジェクトのカイポケリニューアルで ADR を導入しましたというお話です。 ADRとは、「Architecture Decision Record」または、「Architectural Decision Records」の略でアーキテクチャ上で重要な決定を記録するドキュメントです。 詳しくは「DOCUMENTING ARCHITECTURE DECISIONS」 や「Architectural Decision Records」をご覧ください。 また ADR については、以前弊社の酒井が登壇したイベントでも触れられておりますので、こち…

サイボウズがウェブ上に「テクニカルライティングの基本」を公開していたので読んでみた。それによると「概要から具体へ、全体から部分へと説明をすすめる」というのが情報整理において鉄則なのだそうである。 ほかには ・重要なことから書く ・読者視点で書く ・一文一義で書く ・主語や目的語と、述語をちかづける などが書かれていた。やはりというか、まるで守れていない。何を伝えようとしているかわからないことを伝えるための文体だから当然である。 以上、連絡おわり。

近況として、理科系の作文技術を最近少しづつ読み進めています。 www.chuko.co.jp mochikoさんの本など他の参考文献や資料も見ながら、時間をとってテクニカルライティングについての理解を深めています。 techbookfest.org speakerdeck.com テクニカルライティングのような文章・ドキュメントをわかりやすく書くための技術について時間をかけて学んだことはほとんどありませんでした。いわゆる「フィーリング」で文章を書いてきて、これではダメだと思う機会が何回かあったので改めて学習する時間をとっています。 これまで文章を書く中で、わかりやすくするための自分なりの工夫や…