インフラエンジニア向けの書籍を取り上げ、著者と出会い、楽しく本を知り、仲間を作る場所である「インフラエンジニアBooks」。ここで、『ユーザーの問題解決とプロダクトの成功を導く　エンジニアのためのドキュメントライティング』の翻訳を担当した岩瀬氏が登壇。まずは、本書籍の概要について話します。 本セッションの対象者と、セッションのゴール岩瀬義昌氏：ご紹介いただきました、岩瀬と申します。よろしくお願いします。『ユーザーの問題解決とプロダクトの成功を導く　エンジニアのためのドキュメントライティング』は、もともと『Docs for Developers: An Engineer’s Field Guide to Technical Writing』という洋書だったんですが、その翻訳をして、今回この機会をいただいています。 余談ですが、APC（株式会社エーピーコミュニケーションズ）さんが「カプセルトイ

Go Conference 2023 ( 2023/06/02 Fri. ) https://gocon.jp/2023/ 登壇資料 株式会社アンドパッド プロダクトテックリード 小島 夏海 みなさん、Googleが公開したGo Style Guideは読みましたか？ ソフトウ…

ChatGPT が出てきて、平均値なものに価値がなくなって、外れ値に価値があるか、人の役割はノイズを与えるだとか言われているのを聞くが、そんなことはないと思っている。間違い方は無数にあるが、正しいのやり方はほんの少ししかない。なにかをするときには、無数の選択肢の中から、正しいものを選び取っていかないと、ゴールにたどり着かない。ChatGPT だってプロンプトとして与えられるものは無数にあるが、求める答えが得られるプロンプトはわずかだ。正しい答えを素早く得る能力の価値は ChatGPT があっても変わらない。 もちろん人間なので、たまに道から逸れるだろう。外乱もある。でも、その場合も都度都度修正していけば、目的地にたどり着ける。 ChatGPT の画期的なところは即座にフィードバックを与えて修正ができることだ。 だが、修正がなしに一発で決める方が、何度もフィードバックを繰り返すより、速い。仕

最近のお仕事で、C#の非同期処理の書き方が分からずに、溶岩地帯に自爆していくコードを沢山みるようになったので、ケースとして日常風の記事にしてみました。 どんな風にハマってしまい、どうやって解決するのかが分かると思います。 結論 先に書いておきます。 Task.Run()を使ってはいけません Task.Result, Task.Wait()を使ってはいけません Threadクラスを使ってはいけません async-await構文だけを使って書きます async voidにするのは特殊な場合だけです がんばれー、わかってしまえば難しくない！ 補足: もしあなたがJavaScriptで非同期処理を書いた事があるなら、その知識をそのまま生かせます。 JavaScriptではTaskの代わりにPromiseを使いますが、Promiseには上記1,2,3は存在しません。しかし、それで困ることはありません

Deleted articles cannot be recovered. Draft of this article would be also deleted. Are you sure you want to delete this article? はじめに エンジニアにとって、仕様書などの技術的な文章を書くこと（テクニカルライティングとも言います）は避けて通れません。ただ20年来多くのエンジニアの方々と同僚として接してきて思うことは、エンジニアの方の中には「文章を書く」ということに苦手意識がある方が一定数いるということです。 でもこの「テクニカルライティング」のスキルは、才能というよりは一種の「技能」だと思うんです。ある一定の原理原則を理解して実践を繰り返すことで、必ず一定レベルで習得できるものだと著者は信じています。 もしこのテクニカルライティングの原理原則をまだ体系的に学習し

オリジナルはこちら https://www.microsoft.com/en-us/research/academic-program/write-great-research-paper/ http://research.microsoft.com/en-us/um/people/simonpj/papers/giving-a-talk/Writing%20a%20paper%20(seven%20suggestions).pptx 新しいバージョンはこちら https://www.slideshare.net/kdmsnr/how-to-write-a-great-research-paper-226669082Read less

メディアのもとには日々何百通ものプレスリリースが届いていて、目を通してもらえるものだけでも一握り。 タイトルやリード文をパッと見て、惹かれないものは即ゴミ箱行きです。なぜなら、ほとんどは基本の書き方ができていないプレスリリースだから。 「プレスリリースはラブレター」と言われているのを知っていますか？相手のことを考えて伝わる文章が書ければ、きっとメッセージは届きます。 PRにかかわって5年ほど、多くのプレスリリースを見てきた経験をもとに、書き方の決定版をまとめます。 ★プレスリリースについては全10記事以上でまとめていますので、しっかり学びたい人は下記の記事からどうぞ。 手紙のように想いが届く、プレスリリースのすべて【全11記事】広報PRを始める人が最初にぶち当たる壁は、プレスリリースの作成・配信です。 プレスリリースとは、メディアや各ステークホルダーに向け... プレスリリースとは何か？

crontab って便利だけどわかりにくさがある crontab の書き方がおかしくてうまく実行されないとか、そんな書き方があったのか！となることがある。 なので、systemd を使って定期実行することが多いんだけど、そうすると今度は管理が大変になる。 なんだこの定期実行は！となってしまう。 crontab で敢えて書くことの利点 「なんで、いまらさ cron なんだよ。このオッサンは！！」と思われるかもしれない。でもcronを使うメリットは少なからずあると思います。 メリット cronで書くと次のようなメリットがあると思います。 一覧ですぐ確認できる /etc/cron.d に絶対ある コマンドの書き方がシンプル メール通知がかならずある。 書式はパターン化される。 最初に cron は「クロン」と呼びます。 ときどき、「くぅーろん」とか「くろーん」とか余計な母音や長音を含めている人が

サンプル例に見る機能仕様書の基本的な書き方＆読みやすくする7つのテクニック：プロジェクト成功確率向上の近道とは？（2）（1/3 ページ） ITシステム開発の問題点の一つであるコミュニケーションの失敗。本連載では、これを防ぐ方法としてお勧めしたい3つのドキュメントを紹介していく。今回は、Joelの機能仕様書を日本人向けにカスタマイズされたものを例に、機能仕様書の基本的な書き方、読みやすくする7つのテクニック、仕様書作成ツールは何を使うべきか、誰が書くべきかなども解説します。 連載目次 連載の第1回の前回「ドキュメントは最強のコミュニケーションツールである――Joelの機能仕様書入門」では、ITシステム開発がビジネスに貢献していくためには、まずは開発の成功が出発点になること、そしてITシステム開発におけるコミュニケーションの重要性、そしてコミュニケーションにおけるドキュメントの重要性について説

レトリック事典 作者: 佐藤信夫,松尾大,佐々木健一出版社/メーカー: 大修館書店発売日: 2006/11/01メディア: ハードカバー購入: 1人 クリック: 36回この商品を含むブログ (12件) を見る この本は間違いなくスゴイ本です。その名も「レトリック事典」。 文章を書くことを仕事にしている人は多い。仕事にしてなくても、ブログを書いたり、Twitterでつぶやいたり、メールを打ったり。文章を書く作業は全ての人にとってどんどん身近になっています。 文章の文法は学校教育のどこかで習うけれど、"効果的"な文章の書き方を習う場所は少ない。いろんな本を読んで、何となく吸収していく。それがほとんどの人(僕も含めて)の文章の書き方だと思う。 この本は「なんとなく日々文章を書いている」という人たちに是非読んでもらいたい本。 まずページ数がスゴイ。800ページを越えてます。重い。値段も 6,825

コメントは基礎的で一般的なものでありながら、「どのようなことをコメントに残すか」は経験のあるプログラマにとっても難しいもの。 この記事では、アンチパターンコメントを見ながら、どのようなコメントを残すべきかについて説明します。 by 馬場美由紀 （CodeIQ中の人） コードは機械のために、コメントは人間のために? プログラミング言語を学ぶとき、コメントは最初に習う項目のひとつです。そして、プログラムであればコメントを含んでいることが普通です。ある研究によれば、ソースコードの平均19%がコメントだそうです。 コードを書くとき、私たちは機械とコミュニケーションを取ることを意識しています。機械はコードを認識してコンパイルしたり実行してくれます。解釈できなければ教えてくれます。プログラマは、コンパイラのためにデータ型を明示するコードを書いたりもします。 一方、コメントは人間とコミュニケーションする

やっと日本に帰りました。予想外の出来事の連続で、まったく更新が追いつかなくて申し訳なかったのですが、おかげでたくさんのネタを仕入れる事ができました。仕事の宿題も…。 先日紹介した「一流の研究者の Doing リスト」には多くのブックマークをいただき、実践方法の例をいくつかのブログでコメントしていただきました。 ゆっくりと動きながら高速でこなす、を私なりに解釈してみた | シリアル・ポップな日々 ゆっくりと動きながら高速でこなす、を試してみた感想 | 今日とは違う明日 記事を書いた時には、この教授のゆっくりとした動作と脳内のめまぐるしい思考のひらめきとを対比し、着実に「今」をこなしてゆく姿を書きたいと思っていましたので、あえてリストの書き方などといった実践的方法は曖昧にしていました。 ToDo リストの作り方は人それぞれですので、イメージが伝われば、実践方法は自ずから明らかになるだろうと思っ

研究室用に書いた文書を転載します。主に工学系（コンピュータサイエンス系）分野の査読付き学会や論文誌に投稿することを想定しています。 以下は論文を書くときに個人的に気をつけていることです： メッセージをシンプルに：要するに何が言いたいのかが一言でサマライズできていること。記憶に残ること。 メッセージが伝わらないと、そもそも査読で落とされるし、たとえ学会で発表できたとしても誰も覚えていてくれない。実際、国際学会でも発表論文の多くが誰にもリファーされず、翌年になると忘れられている (どんな論文がどのくらい参照されているかはGoogle Scholar, Microsoft Academic Searchなどでわかる）。 問題はなにか・なぜこの問題が重要なのか・問題の原因は何か・どんな解決案を提案するのか・その効果は本当か・他にどんな研究があるか（なぜそれらの既存研究ではだめなのか）・誰のために役