【翻訳】Googleのエンジニアがソフトウェア開発する時に必ず書くドキュメント「Design Docs at Google」 - BppLOG
Googleでの「Design Docs」とは 2007年の Google Developer Day Tokyo での鵜飼氏のプレゼンによると「Google で必ず書くことになっているドキュメント」であり、「プロジェクト立ち上げ時の 1～2週間をかけて書く」ものです。 今回は Google のソフトウェアエンジニアである @cramforce 氏が自身のブログで「Googleでの Design Docs」について解説している記事を公開されていたため、氏の許可を得て翻訳しています。 原文： www.industrialempathy.com 関連書籍： Googleのソフトウェアエンジニアリング ―持続可能なプログラミングを支える技術、文化、プロセス オライリージャパンAmazon 読了目安：11分 (目次) デザインドキュメント の解剖学 文脈と範囲 目標と非目標 実際のデザイン システ
アメリカの職場にいると、日本にいるときよりも身近でレイオフだとか、職を変えるというのを頻繁に見かける。先日もそういう場面があったのだが昔日本で働いていた時のことを思い出した。 ドキュメントを書く理由 日本のソフトウェア企業にいたときは、「納品物であるから」という理由以外にも、「人がいなくなったときに会社が困るから」という理由でもドキュメントを書くことが推奨されていた。しかし、少なくとも今の職場ではそんな理由でドキュメントを書くのは推奨されていないのに、なぜ問題にならないのだろうとふと思った。 うちのマネージャは、バディ制ににして、みんな休暇できるようにしようとは言っているが、多分本当に退職対策ではないと思う。 チームのメンバーが抜けたときも、「とても残念で、ワークロードをどうしようという問題はあるけど、彼女の門出を祝福しよう」言っていた。つまり、こちらでも「工数」は問題になるけど、「引継ぎ
ドキュメントに固執せよ - gfnweb
どうして人間集団はこんなにも知見の共有を円滑にできないのか？ 改善にはドキュメントにまつわる各個人の心構え・制度設計・技術的解決の全部が必要だという話をしたい． ここでテーマにしているのは，著名OSSなど世の中にいくらでも知見が転がっている対象ではなく，特に企業内の十数人のチームでクローズドに開発しているなどして集合知に頼れない状況下でのドキュメントについてである． 非常に乱暴な言い方をするなら，「コードとか大部分は誰でも書けるようになるものなんよ，そんなところにマッチョイズムとか感じなくてええねん，我々の知的体力や組織性が真に試されるのはドキュメントちゃうんか」という気持ちです — 画力・博士号・油田 (@bd_gfngfn) June 3, 2022 ドキュメントに書く内容の必須項目或るシステム（ソフトウェアなど）について，そのシステムのことを全く知らない人を想定読者としたドキュメント
「日本人は幻想を抱く」新型コロナと闘うウイルス学者の『情熱大陸』のドキュメントがすごい！（追記あり）(水島宏明) - 個人 - Yahoo!ニュース
専門家会議のメンバーになっている研究者のドキュメンタリー TBS系で毎週日曜夜に全国放送しているドキュメンタリー番組『情熱大陸』（制作は毎日放送＝MBS）。 4月12日（日）夜の放送回でクローズアップしたのはウイルス学者・河岡義裕だ。 世界で初めてインフルエンザウイルスの人工合成に成功した研究者だ。 番組の冒頭はアフリカでエボラ出血熱の謎を調べるために河岡がコウモリの血液を採取して抗体を調査する場面だ。 河岡はエボラウイルスの人工合成にも成功して、その技術がワクチン開発などに生かされているという。 この河岡義裕は新型コロナウイルスで政府に提言を行う専門家会議のメンバーだ。 新型コロナウイルスの感染防止が日本のあらゆる国民、いや全世界の人たちにとって最も重要な課題になっているこのタイミングで、この人物を取り上げてドキュメンタリーで放送することだけで「ありえない」ぐらい難しいことだ。 なぜなら
［速報］「GitHub Copilot X」発表、GPT-4ベースで大幅強化。AIにバグの調査依頼と修正案を指示、ドキュメントを学習し回答も
［速報］「GitHub Copilot X」発表、GPT-4ベースで大幅強化。AIにバグの調査依頼と修正案を指示、ドキュメントを学習し回答も GitHubは、GTP-4をベースに「GitHub Copilot」の機能を大幅に強化した「GitHub Copilot X」を発表しました。 GitHub Copilot is already helping developers code faster in their IDEs. But what’s next? Our answer is GitHub Copilot X. It’s our vision for the future of AI-powered software development. Check it out https://t.co/3Xrn7dAPgi — GitHub (@github) March 22, 202
その作品は、“まるでドキュメンタリーのような演技だ”と評されます。 ことしのカンヌ映画祭、「ドライブ・マイ・カー」で脚本賞を受賞した映画監督の濱口竜介さん。 ことしの世界3大映画祭のうち、2つの映画祭でそれぞれ別の作品が主要な賞を受賞、一躍世界に注目されています。 俳優の自然な演技を引き出す、「濱口メソッド」と呼ばれる独特の演出法に迫りました。 （科学文化部記者・加川直央 ヨーロッパ総局記者・古山彰子）
Google エンジニアリング・プラクティス ドキュメント このページは、Google Engineering Practices Documentation の非公式な日本語翻訳です。元のドキュメントは、クリエイティブ・コモンズの「CC-By 3.0」ライセンスで公開されています。 Google には、あらゆる言語・あらゆるプロジェクトをカバーする一般化されたエンジニアリング・プラクティスが数多く存在します。こうしたドキュメントは、私たちが長年に渡って開発してきたさまざまなベストプラクティスの経験が集結したものとなっています。オープンソース・プロジェクトやその他の組織でも、こうした知識から恩恵を受けられるかもしれません。そのため、私たちは可能な限り、この知識を公開するように努めています。 現在、以下のドキュメントが公開されています。 Google コードレビューガイドライン (Googl
社内ドキュメントはなぜ更新されないのか？情報の鮮度を最小限の運用負荷で維持する「イミュータブルドキュメントモデル」のススメ - KAKEHASHI Tech Blog
はじめに こんにちは。カケハシの各プロダクトを支えるプラットフォームシステムの開発チームでテックリードを担当しているkosui(@kosui_me)です。 プロダクト開発の世界では、明瞭な社内向けドキュメントを書くための方法が数多く提案されてきました。読者の中には、製品要求を明瞭にするためにPRD (Product Requirements Document、製品要求仕様書) を書き、プロジェクトの背景から全体の設計やその代案について明瞭にするためにDesign Docsを書き、アーキテクチャに関する意思決定の記録を明瞭にするためにADR(Architecture Decision Record) を書いてきた方も数多くいらっしゃると思います。 しかし、どんな素晴らしいドキュメントも、何故か更新されなくなります。新メンバーへのオンボーディングのためにインフラ構成図を検索したあなたが見つけた
インフラエンジニア向けの書籍を取り上げ、著者と出会い、楽しく本を知り、仲間を作る場所である「インフラエンジニアBooks」。ここで、『ユーザーの問題解決とプロダクトの成功を導く エンジニアのためのドキュメントライティング』の翻訳を担当した岩瀬氏が登壇。まずは、本書籍の概要について話します。 本セッションの対象者と、セッションのゴール 岩瀬義昌氏：ご紹介いただきました、岩瀬と申します。よろしくお願いします。『ユーザーの問題解決とプロダクトの成功を導く エンジニアのためのドキュメントライティング』は、もともと『Docs for Developers: An Engineer’s Field Guide to Technical Writing』という洋書だったんですが、その翻訳をして、今回この機会をいただいています。 余談ですが、APC（株式会社エーピーコミュニケーションズ）さんが「カプセルト
2004年1月2月に放送された番組だが、先日の11月8日9日の深夜に再放送された。今はNHKプラスの配信で一週間見ることができる。 選「ドキュメント・エルサレム」(前編) - NHKスペシャル - NHK https://www.nhk.jp/p/special/ts/2NY2QQLPM3/episode/te/MV8W36W6XX/ （追記：後編のURLもつけときます。選「ドキュメント・エルサレム」(後編) - NHKスペシャル - NHK https://www.nhk.jp/p/special/ts/2NY2QQLPM3/episode/te/XZR9W44JV3/ ） 最近作られた「映像の世紀」とかのイスラエルドキュメンタリーやパレスチナ紛争の解説番組なんかと比べてよっぽど中身があった。 イスラエルの穏健派政治家たちが和平を結ぼうとするたびに、虐殺者シャロン率いるリクードなどの大イ
こんにちは。壮（@sew_sou19）と申します。 メガベンチャー企業でエンジニアとして働いています。 エンジニアにジョブチェンジした当初は、ドキュメントの書き方なんてこれっぽっちも分かりませんでした。読みやすいドキュメントを書くことが本当に苦痛だったのですが、考えて、試行錯誤し続けた結果、以下のような評価を得るに至りました。 リーダーから「君は情報の整理が上手でドキュメントが本当に読みやすい。チーム全体の能力向上に繋げたいからドキュメント書く際のポイント共有してほしい」と言われたので、意識していることを言語化しつつテクニカルライティングの本でインプットしてるけど、学びが多い。ついでにnoteにもまとめてる — 壮 (@sew_sou19) November 28, 2022 そこでこのnoteでは、僕がドキュメントを作成するときに、特に意識して実践している7つのことを書きます。（本当は2
こんにちは丸山@h13i32maruです。つい先日、devchat.fmというポッドキャストに出演して、「ドキュメント」というお題について話しました。なぜこんなニッチなお題について話したかというと、Ubie Discoveryに入社して5ヶ月の間にいくつか*1まとまったソフトウェアドキュメントを書いたので、自分の中でホットな話題だったからです。 #devchatfm 33回目は、Ubie DiscoveryのSWE @h13i32maru にドキュメントを書くことで得られるメリットや、ポイント・工夫などを聞きました！ #33 チームの生産性を上げるドキュメントのすすめ with@h13i32maruhttps://t.co/TrmZd13D91— 久保 恒太 / Ubie CEO (@quvo_ubie) 2021年8月12日 これらのドキュメントは個人的にわりと良く書けたと思ってますし、
安野モヨコが夫・庵野秀明のドキュメントを見たら「カメラの前でほとんど心を開かないままに終わったのでひっくり返った」。監督の＜断固として＞との姿勢を生き方の指針に 還暦不行届｜話題｜婦人公論.jp
漫画『ハッピー・マニア』で人気を博し、その後の作品『シュガシュガルーン』では第29回講談社漫画賞を受賞するなど、数々の名作を生み出している、漫画家・安野モヨコさん。そして、安野さんのパートナーはアニメ『新世紀エヴァンゲリオン』の監督・庵野秀明さん。このクリエイティブなご夫婦は一体どんな生活を送っているのでしょうか。安野さんは、「監督は眠っている時の姿が浜辺に打ち上げられた棒みたい」と言っていて――。 集中力 監督は眠っている時の姿が変わっていて 浜辺に打ち上げられた棒みたいに一本になって寝ている。 体の中にある本体が抜け出して、その際入れ物である肉体を ぽいと投げ出して出かけてった、というような感じがする。 なんでそんなふうに感じるかというと 普段から監督の動きがそんな様子だからだ。
システム開発にドキュメントは欠かせません。ドキュメントが得意になれば活躍の幅が大いに広がりますよね。 この記事では、まず冒頭でドキュメントの作成に求められると思うことを整理した上で、そのスキル獲得に役立つと思われる記事や書籍を集めてみました。もちろん他にもあると思うので、もしお薦めのものがあれば是非コメントで教えて下さい 更新履歴 ・2021/04/16：文章術系にリンクを追加しました。 ・2020/11/28：文章術系にリンクを追加しました。 ・2020/07/24：文章術系にリンクを追加しました。 ・2020/05/24：文章術系にリンクを追加しました。 ・2020/05/14：スライドデザイン系にリンクを追加しました。 ・2020/04/29：スライドデザイン系にリンクを追加しました。 ・2020/04/17：文章術系にリンクを追加しました。 ・2020/04/12：関連するTwit
プログラマーがドキュメントを書かない理由
この記事は、著者の許可を得て配信しています。 Why programmers don’t write documentation 最近ではずっとコードのドキュメンテーションに関連した記事を書いていたので、当然、私のMediumのおすすめ記事には「開発者がドキュメントを書かない本当の理由」という記事が表示されるようになりました。この記事では、ドキュメントを書くための優れたツールがないことが、ソフトウェアエンジニアが自分の作業や判断をドキュメンテーションする意欲を失わせる最大の原因について書いています。 私は普段、特定の記事を批判したりはしませんが、この記事には怒りを覚えました。このライターは図解ツールについていくつかメリットに関して述べてはいますが、全体的に誤解を招くような内容になっており、この重要な問題をより分かりにくくさせています。2つの図解ツールを比較して、どちらも不十分なツールである
河瀬直美監督ドキュメント映画『東京2020オリンピックSIDE：B』には、なぜ「最も重要な人物」が1秒も映らないのかという話｜CDBと七紙草子
河瀬直美監督ドキュメント映画『東京2020オリンピックSIDE：B』には、なぜ「最も重要な人物」が1秒も映らないのかという話 河瀬直美監督が東京五輪ドキュメンタリーを撮る、と報じられた時、左派からよく引き合いに出されたのはベルリン五輪におけるレニ・リーフェンシュタールだった。要はリーフェンシュタールがナチス政権にそうしたような、東京五輪を美化するプロパガンダになるのではないかという危惧である。 先月に公開された『東京2020オリンピックSIDE：A』を見た時、その心配は杞憂に終わったと感じた。そこにあるのは良くも悪くも監督のメッセージが脱主体化された、東京五輪に参加する各国の選手たちの肖像、さまざまな思いをつないだグラフィティ的な作品になっていたからだ。そこにあるのは良質ではあるが凡庸な記録映画であって、リーフェンシュタールの作品のような強烈な求心力やプロパガンダ性はない。 しかし、である
NHK『のぞき見ドキュメント #100カメ』がTwitter社に潜入→警察からの削除要請、2週に一度の新入社員入社、飲みニケーション重視などの実態が明らかに
NHKドキュメンタリー @nhk_docudocu 【27日夜】 #ツイッター 社の裏側に固定カメラ100台で潜入！身近なSNSの“中の人”たちって…？ 秘密オンパレードの現場 #100カメ 番組史上最大の壁が立ちはだかる。それでも浮かび上がる、意外な実態とは。 27日(月)夜10時50分から放送予定。[総合] #オードリー nhk.or.jp/docudocu/progr… 2020-01-26 10:00:12 リンク NHKドキュメンタリー - 【ストーリーズ】のぞき見ドキュメント １００カメ「ツイッター社」 NHKドキュメンタリー - 【ストーリーズ】のぞき見ドキュメント １００カメ「ツイッター社」 １００カメ「ツイッター社」をのぞき見！ 56
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く
アメリカの職場ではなぜドキュメントも無いのに人が去っても問題ないのだろう？｜牛尾 剛
演技なのか、ドキュメントなのか 世界を魅了!「濱口メソッド」 | NHK | WEB特集
Google エンジニアリング・プラクティス ドキュメント
「ドキュメントの書き方」を体系的に学んだことがないエンジニアへ 書籍『エンジニアのためのドキュメントライティング』の概要
NHKスペシャル「ドキュメント エルサレム（前後編）」がすごかった
読みやすいドキュメントを書くために今日からできる7つのこと｜壮｜Masato Tanaka
ソフトウェアドキュメント作法 - maru source
ドキュメント作成スキル向上を目指す人向けおすすめ記事まとめ - Qiita