【翻訳】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 エンジニアリング・プラクティス ドキュメント このページは、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日 これらのドキュメントは個人的にわりと良く書けたと思ってますし、
システム開発にドキュメントは欠かせません。ドキュメントが得意になれば活躍の幅が大いに広がりますよね。 この記事では、まず冒頭でドキュメントの作成に求められると思うことを整理した上で、そのスキル獲得に役立つと思われる記事や書籍を集めてみました。もちろん他にもあると思うので、もしお薦めのものがあれば是非コメントで教えて下さい 更新履歴 ・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
仕事ですぐに使えるTypeScript — 仕事ですぐに使えるTypeScript ドキュメント
注釈 本ドキュメントは、まだ未完成ですが、ウェブフロントエンドの開発を学ぶときに、JavaScriptを経由せずに、最初からTypeScriptで学んでいく社内向けコンテンツとして作成されはじめました。基本の文法部分以外はまだ執筆されていない章もいくつもあります。書かれている章もまだまだ内容が追加される可能性がありますし、環境の変化で内容の変更が入る可能性もあります。 書籍の原稿はGitHub上で管理しております。もしTypoを見つけてくださった方がいらっしゃいましたら、 GitHub上で連絡 をお願いします 1 。reSTファイルだけ修正してもらえれば、HTML/PDFの生成までは不要です。フィードバックなども歓迎しております。 1 https://github.com/future-architect/typescript-guide/pulls
安野モヨコが夫・庵野秀明のドキュメントを見たら「カメラの前でほとんど心を開かないままに終わったのでひっくり返った」。監督の＜断固として＞との姿勢を生き方の指針に 還暦不行届｜話題｜婦人公論.jp
漫画『ハッピー・マニア』で人気を博し、その後の作品『シュガシュガルーン』では第29回講談社漫画賞を受賞するなど、数々の名作を生み出している、漫画家・安野モヨコさん。そして、安野さんのパートナーはアニメ『新世紀エヴァンゲリオン』の監督・庵野秀明さん。このクリエイティブなご夫婦は一体どんな生活を送っているのでしょうか。安野さんは、「監督は眠っている時の姿が浜辺に打ち上げられた棒みたい」と言っていて――。 集中力 監督は眠っている時の姿が変わっていて 浜辺に打ち上げられた棒みたいに一本になって寝ている。 体の中にある本体が抜け出して、その際入れ物である肉体を ぽいと投げ出して出かけてった、というような感じがする。 なんでそんなふうに感じるかというと 普段から監督の動きがそんな様子だからだ。
プログラマーがドキュメントを書かない理由
この記事は、著者の許可を得て配信しています。 Why programmers don’t write documentation 最近ではずっとコードのドキュメンテーションに関連した記事を書いていたので、当然、私のMediumのおすすめ記事には「開発者がドキュメントを書かない本当の理由」という記事が表示されるようになりました。この記事では、ドキュメントを書くための優れたツールがないことが、ソフトウェアエンジニアが自分の作業や判断をドキュメンテーションする意欲を失わせる最大の原因について書いています。 私は普段、特定の記事を批判したりはしませんが、この記事には怒りを覚えました。このライターは図解ツールについていくつかメリットに関して述べてはいますが、全体的に誤解を招くような内容になっており、この重要な問題をより分かりにくくさせています。2つの図解ツールを比較して、どちらも不十分なツールである
河瀬直美監督ドキュメント映画『東京2020オリンピックSIDE：B』には、なぜ「最も重要な人物」が1秒も映らないのかという話｜CDBと七紙草子
河瀬直美監督ドキュメント映画『東京2020オリンピックSIDE：B』には、なぜ「最も重要な人物」が1秒も映らないのかという話 河瀬直美監督が東京五輪ドキュメンタリーを撮る、と報じられた時、左派からよく引き合いに出されたのはベルリン五輪におけるレニ・リーフェンシュタールだった。要はリーフェンシュタールがナチス政権にそうしたような、東京五輪を美化するプロパガンダになるのではないかという危惧である。 先月に公開された『東京2020オリンピックSIDE：A』を見た時、その心配は杞憂に終わったと感じた。そこにあるのは良くも悪くも監督のメッセージが脱主体化された、東京五輪に参加する各国の選手たちの肖像、さまざまな思いをつないだグラフィティ的な作品になっていたからだ。そこにあるのは良質ではあるが凡庸な記録映画であって、リーフェンシュタールの作品のような強烈な求心力やプロパガンダ性はない。 しかし、である
日本テレビ系「NNNドキュメント’19」が2日"「自爆」元警部の告発"を放送する 北海道警の稲葉圭昭氏が覚醒剤取締法違反で逮捕された後に浮上した"やらせ捜査"に迫る 調査開始後に関係者の自殺が続いたという道警の真実について、稲葉氏が口を開く
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
昨日観た番組とそこで得た気づき、今日観たい番組などを毎日更新で綴る、てれびのスキマによる2021年のテレビ鑑賞記録。 『家、ついて行ってイイですか？』4時間半SP すごいものを観た……。オナニーマシーン・イノマーのドキュメント。泣いた。だけど、泣いたと書くのはあまりに軽過ぎる。 もともと、番組スタッフが下北沢で終電を逃した人を探していたところ、イノマーのパートナー・ヒロさんと遭遇したことが始まりだった。なんとその日は彼の葬儀が行われた日。死後4日の2019年12月23日のことだった。スタッフが「こんな状況でアレなんですけど、家、ついて行ってイイですか？」と取材を申し込むと「どうでしょうね……」と一瞬躊躇しながらも「故人もこの番組すごい好きで」と、彼女は引き受けた。取材ディレクターはこの時点ではオナニーマシーンの存在も知らない。ヒロさんが「本当に命を使い切って死んでいった」と、彼の最期の生き
良いドキュメントを書きたくなる本を読んだらドキュメンタリアンになりたくなった - じゃあ、おうちで学べる
ドキュメンタリアンとは、役職に関係なく、ソフトウェア業界でドキュメントとコミュニケーションに関心を持つ人のことです。 www.writethedocs.org はじめに これは主に『ユーザーの問題解決とプロダクトの成功を導く エンジニアのためのドキュメントライティング』の書評です。私はSreakeにてSREという役職についています。SREはサービス概要、アーキテクチャの解説や図、各種構成図、各種手順書、ポストモーテム、ポリシー、SLA(SLO) … その他の様々な場面でドキュメントを書く必要があります。しかし、ドキュメントは価値が見えにくく時間と労力がかかり品質担保の面で重要度がとても高いのにその場での価値が見えにくいので浸透しにくいです。そのため、エンジニアとしてモチベーションが保ちづらいです。2021年 State of DevOps 2021 にもドキュメントに関する言及があり今後、
Jira SoftwareやTrelloなどを中心としたPMが経験してきたプロダクト管理ツールの失敗や改善を語る「本当に使いこなせてる？プロダクト管理ツールの失敗&改善PMトーク【開発PM勉強会 vol.20】」。ここで株式会社ビズリーチの菊池氏が登壇。ドキュメント管理とプロダクトバックログの失敗から学ぶツール運用のコツについて紹介します。 菊池氏の自己紹介 菊池信太郎氏（以下、菊池）：ビズリーチの菊池から、10分枠で話をします。今日のテーマは「失敗から学ぶドキュメントとチケット運用のコツ」ということで、今まで経験したところで「こういうアンチパターンがあったよ」「こういう改善をしたよ」というようなところをお話しできればと思っています。 自己紹介を軽くすると、（私は）2018年からビズリーチで働いています。ビズリーチサービスを作っていて、プラットフォーム開発部の部長をしています。また、201
はじめにTIG真野です。 秋のブログ週間2023 の3本目は、設計ドキュメントをGit管理して腐らせないようにがんばってみた話をします。 前段として6年前、「我々はいかにシステム開発におけるドキュメント腐る問題と戦えば良いのか」という記事を書いたのですが、その後の試行錯誤はどこにも残していないことに気づきました。普段のフューチャー技術ブログですとちょっと引け目を感じるテーマですが、秋の夜長を楽しむため読み物成分を多めに書くというテーマのこのブログリレーにピッタリな気がするため、この機会をお借りします。 ドキュメントも色々な種別があるかと思いますが、この記事では設計ドキュメントを指すことにします。設計ドキュメントは開発メンバーが参照するもので、ステークホルダーへの説明資料に引用して使うことはあれど、主目的は異なるという前提です。Design Docの場合もありますし、システム構成図、ERD、
話題の ChatGPT + LangChain で、膨大な PDF ドキュメントの内容を爆速で把握する - Qiita
話題の ChatGPT + LangChain で、膨大な PDF ドキュメントの内容を爆速で把握するPDFOpenAIChatGPTlangchain記事投稿キャンペーン_ChatGPT はじめに 本記事では、ChatGPT と LangChain の API を使用して、PDF ドキュメントの内容を自然言語で問い合わせる方法を紹介します。 具体的には、PDF ドキュメントに対して自然言語で問い合わせをすると、自然言語で結果が返ってくる、というものです。 ChatGPT と LangChain を使用することで、下記のような複数ステップの仕事を非常に簡単に実行させることができます。 PDF ドキュメントからテキストを抽出して複数に分割する 分割したテキストからテキスト間の関連を表すベクターデータを作成する 作成したベクターデータをベクターストアに格納しておく ChatGPT に外部から与
こんにちは。電通デジタルでEMをしている河内です。エンジニアにおける採用・評価、スクラムマスターなどを担当しています。今回はすこし実装プラクティスから離れた話題になりますがお付き合いくださいませ。 弊社もご多分に漏れず完全テレワークを実施しており、かれこれ4か月が経ちます。その中で見えてきた課題とエンジニアチームとしてどう対峙したか、そしてそこで得た気づきを綴っていきたいと思います。この内容は、過去に開催したオンラインイベントでお話した内容になります。 テレワーク環境で私たちのエンジニア部門で急務と感じた課題テレワークが開始された2月後半、プログラミングやシステム開発プロジェクトを生業とする私たちの部では「リモート？全然OK。支障無いっす。」とタカを括っておりました。しかし開始されて間もなく、やっぱり慣れていない事が判明・・・。テレワークを経験されている読者の多くの方が感じていることと同様
EC サイトの URL 構造 ベスト プラクティス | Google 検索セントラル | ドキュメント | Google for Developers
フィードバックを送信 コレクションでコンテンツを整理 必要に応じて、コンテンツの保存と分類を行います。 e コマース ウェブサイトの URL 構造を設計する Google が e コマースサイトのウェブページを効率的に発見して取得できるように、URL を適切に設計してください。お客様が URL の構造を管理されている場合には（たとえば、独自のサイトをゼロから構築されているなど）、このガイドを参考にして URL 構造を決定すると、Google が e コマースサイトをインデックス登録する際の問題を回避できます。 URL 構造が重要である理由 URL 構造の設計が適切であれば、Google はサイトをクロールしやすく、インデックス登録もしやすくなります。URL 構造に不十分な点があれば、以下の問題が発生する可能性があります。 Googlebot が 2 つの URL で同じコンテンツが返される
Agile Manifestoには以下のように書いてあります。 動作するソフトウエアは包括的なドキュメントにまさる ともするとドキュメント軽視と取られかねない宣言です。この宣言を誤って解釈してドキュメントはいらないとなる場合もあるかもしれませんが筆者はそれは間違いだと思っています。この宣言では包括的なドキュメントよ
2020年後半版Vue.jsを使ってる人には必ず知っていてほしいVue.jsの武器とドキュメントに書かれていないコンポーネントやメンテナンスの際に役立つTips - Qiita
2020年後半版Vue.jsを使ってる人には必ず知っていてほしいVue.jsの武器とドキュメントに書かれていないコンポーネントやメンテナンスの際に役立つTipsJavaScriptTypeScriptVue.jsフロントエンドvue-cli はじめに 最近iCAREさんの所でVue.jsを一緒にやらせていただいているのですが、フロントの技術スタックがGraphQL + Vue.js + TypeScriptで開発しており、そこでのVue.jsの開発体験がかなり良く、iCareさんの詳細なノウハウを公開しても良いと言っていただけたので、言語化し、整理して、共有出来たらと思います. ※ いつも通り記事の内容に意見がありましたら直接編集リクエストをください 前置き 今回のサンプルは@vue/cliを利用し、プリセットはTypeScriptだけいれときました. versionは2020年7月16日
「すげえ。パクってやがる。ここまでクズども、見たことねえ」小説落選、青葉被告が徐々に過激行動へ 大宮駅前無差別殺人事件計画を初めて語る【ドキュメント京アニ裁判⑦被告人質問】 | TBS NEWS DIG
「すげえ。パクってやがる。ここまでクズども、見たことねえ」小説落選、青葉被告が徐々に過激行動へ 大宮駅前無差別殺人事件計画を初めて語る【ドキュメント京アニ裁判⑦被告人質問】
Googleがコードレビューのガイドラインなど、ソフトウェアエンジニアリング実践のためのドキュメント「Google Engineering Practices Documentation」を公開
Googleがコードレビューのガイドラインなど、ソフトウェアエンジニアリング実践のためのドキュメント「Google Engineering Practices Documentation」を公開 ライセンスはクリエイティブコモンズの「表示 3.0 非移植 (CC BY 3.0)」で、複製や再配布、営利目的を含めた改変や翻案が可能になっています。 Googleで一般化されたエンジニアリングプラクティス Googleはこのドキュメントを次のように紹介しています。 Google has many generalized engineering practices that cover all languages and all projects. These documents represent our collective experience of various best practic
文章を書く前にやることよい文章を書くには、実際に文章を書く前に、読者は誰か、どういう悩みを解決するのかを企画することが大切です。また、それを元にアウトラインを書いておきます。 このふたつを元に文章を書くことで、読みやすい開発ドキュメントにつながります。これについては、次の記事をご覧ください。 開発ドキュメントを書く前に決めるべき3つのこと【企画編】開発ドキュメントにおけるアウトラインの書き方開発ドキュメントの書き方企画とアウトラインの作成が終わったら、実際に文章を書いていきます。文章を書くときは、次の9つを意識して書きます。これだけで、読みやすさ、分かりやすさが大きく向上します。 一文を短く切る結論を先に述べる指示語を使わない主語を明確にする、述語との距離を近づけるひらく・閉じるを統一する再現条件を示す前提を揃える見出しや箇条書き、表などを適切に用いる読者に伝わる用語を使うひとつずつ説明し
NHK『ドキュメント シン・仮面ライダー〜ヒーローアクション挑戦の舞台裏』で明かされた現場の雰囲気は地獄。池松壮亮の苦悶に涙
『シン・仮面ライダー』【公式】 @Shin_KR 『シン・仮面ライダー』 原作： #石ノ森章太郎 脚本・監督： #庵野秀明 出演： #池松壮亮 #浜辺美波 #柄本佑 #シン・仮面ライダー #仮面ライダー ©石森プロ・東映/2023「シン・仮面ライダー」製作委員会 プライムビデオにて独占配信中。 shin-kamen-rider.jp 『シン・仮面ライダー』【公式】 @Shin_KR 強烈な個性を放つ登場人物たちの関係性が描かれる 特別映像を、3日間連続で解禁いたします。 第2弾は【本郷猛×一文字隼人編】です。 なお、明日31日(金)には、緑川ルリ子×ハチオーグ／ヒロミ編を公開いたします。 御期待ください。 #シン・仮面ライダー pic.twitter.com/2yaYHfdSdl 2023-03-30 19:00:01 『シン・仮面ライダー』【公式】 @Shin_KR 本日はハチオーグ関連
選「ドキュメント・エルサレム」(前編) - NHKスペシャル
ユダヤ教、キリスト教、イスラム教の三つの宗教の聖地、エルサレム。３０００年にわたり様々な衝突の震源地となってきた。世界を揺るがしている紛争がどのように始まったのかを、二組の父子と貴重な記録映像で検証する。２回シリーズの前編。
分かりやすいドキュメントを書く「テクニカルライター」という仕事 / About the job "Technical writer" who writes easy-to-understand documents
もともとインフラエンジニアをしていた私が、LINEに入るまで知らなかった「テクニカルライターという職種があること」と「LINEにはテクニカルライティング専門のチームがあること」の2つについてお話しします。技術も好きだし、ドキュメントを書いたり、人に教えたりするのも好きだ、という方に「こういうキャリアもあるんだ」と発見してもらえるセッションです。 ■ 発表者 堀越 良子 / LINE株式会社 テクニカルライター。元インフラエンジニア。ねこが好き。 https://twitter.com/mochikoAsTech ■ セッション動画 https://youtu.be/nmFVXJGiCxM?t=2817 ※こちらは以下イベント内で発表した内容です https://line.connpass.com/event/205655/
マイクロソフト、ChatGPTに任意のドキュメントを読み込ませて回答を得られる「Azure OpenAI Service On Your Data」パブリックプレビュー開始
マイクロソフトは、ChatGPTとChatGPT-4に任意のドキュメントなどを読み込ませることで、そのドキュメントに基づいた回答を自然言語で得られる新サービス「Azure OpenAI Service On Your Data」のパブリックプレビューを発表しました。 例えば、社内規約や社内マニュアルなどをChatGPTに読み込ませると、「PCの修理を申し込むための社内手続きは？」といった、汎用の知識だけしか持たない従来のChatGPTでは答えられない質問にも回答できるようになります。 さらに、ChatGPT/ChatGPT-4に任意のドキュメントを読み込ませるための支援ツール「Azure AI Studio」には、そのままチャットボットAIをWebアプリケーションとして公開する機能が備わっています。 これにより、ドキュメントやデータを読み込ませるように設定したチャットAIのサービスを、簡単
出かける前にドキュメンタリー映画『僕たちの嘘と真実 Documentary of 欅坂46』を観たんですが、フタ開けてみたらドキュメンタリーどころか「人死なないだけのサイコスリラー」で、観終わったあと心砕かれて全部の予定キャンセルした。 トップアイドルグループの5年感の奇跡の軌跡なんかじゃなく、「1人の普通の女の子がブッ壊れるまでの過程」を描いたリアルスリラーかつリアルホラー。しばらく人と関わりたくない。 ただ「ブッ壊れる」ことが「不幸」かどうか俺にはなにもわからない。言い換えればこれは「才能の覚醒」だった。それを不幸と言ってしまえば平手友梨奈、欅坂そのものを否定してしまうことになりかねないし、幸せか不幸かなんて本人達にしかわからない。だから否定はしないですが、ひたすらシンプルに嫌いな映画でした。この映画の収益が彼女達にどれだけ還元されてるのか知りたい。給料が歩合じゃなく月給制だったら俺は
TypeScriptの世界を知る 前書き Node.jsエコシステムを体験しよう TypeScriptの書き方 変数 プリミティブ型 複合型 基本的な構文 基本的な型付け 関数 その他の組み込み型・関数 クラス 非同期処理 例外処理 モジュール console.logによるログ出力 中級のテクニック ジェネリクス 関数型指向のプログラミング クラス上級編 リアクティブ 高度なテクニック 環境ごとのTips（共通環境・ブラウザ以外） ソフトウェア開発の環境を考える 基本の環境構築 ライブラリ開発のための環境設定 CLIツール・ウェブサーバー作成のための環境設定 CI（継続的インテグレーション）環境の構築 成果物のデプロイ 使用ライブラリのバージョン管理 環境ごとのTips（ブラウザ環境） ブラウザ環境 ブラウザ関連の組み込み型 Reactの環境構築 create-react-appによる環境
ドキュメントの文章校正には、textlintが便利 - Cybozu Inside Out | サイボウズエンジニアのブログ
こんにちは！ 開発部 テクニカルコミュニケーションチーム（以下、TCチーム）の原嶋です。 さてさて。 みなさん、ドキュメントの文章校正（以下、校正）ってどんな風にやっていますか？ 目視チェックでバッチリだぜ！という方も もちろんいると思うのですが、チェックポイントが多いと指摘が漏れてしまいがちですよね。そして、会社の公式文書となれば、チェックポイントはあれもこれもと山のようになります。 TCチームでも長年 校正に頭をかかえていましたが、textlint と＋αのツール を使って、校正の悩みを解決しました。 今回はその経緯をお話させてください。 校正って確認する項目がたくさん TCチームでは、サイボウズ製品のユーザーサポートコンテンツ（ヘルプやリリースノートなど）を作成しているのですが、 それらのコンテンツは会社の公式文書なので、毎回の校正でチェックする項目が多々あるんです。 校正おわったー
市野川 @irsaitama IT業界に居ると、海外製品の日本語ドキュメントが無くなったり機械翻訳になったりして、年々ローカライズが手抜きになっていく点に我が国の経済的な没落を実感する 2022-06-26 12:09:56
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く
アメリカの職場ではなぜドキュメントも無いのに人が去っても問題ないのだろう？｜牛尾 剛
演技なのか、ドキュメントなのか 世界を魅了!「濱口メソッド」 | NHK | WEB特集
「ドキュメントの書き方」を体系的に学んだことがないエンジニアへ 書籍『エンジニアのためのドキュメントライティング』の概要
NHKスペシャル「ドキュメント エルサレム（前後編）」がすごかった
読みやすいドキュメントを書くために今日からできる7つのこと｜壮｜Masato Tanaka
ソフトウェアドキュメント作法 - maru source
ドキュメント作成スキル向上を目指す人向けおすすめ記事まとめ - Qiita
警察の違法捜査の実態を「NNNドキュメント’19」で放送 北海道警のエースは逮捕｜ニフティニュース
あんどぅ on Twitter: "本番運用するといずれ誰もがたどり着く、公式ドキュメントには書かれてないログ管理の現実解が資料化されていてすばらしい そう、CloudWatch LogsにはDev環境 or ERRORの場合のみ飛ばすFluentdの設定をすることで利便性と料金のバランスをとるのである これは公式ドキュメントにすべき https://t.co/RE4FmPCpJX"
オナニーマシーン・イノマー「命を使い切って死んだ」最期の生き様を映したドキュメント（てれびのスキマ） - QJWeb クイック・ジャパン ウェブ
破綻したドキュメント管理、増え過ぎたプロダクトバックログ… 「Jira」「Confluence」などの活用失敗から学ぶツール運用のコツ
設計ドキュメント腐る問題、Git管理で運用してみた結果 | フューチャー技術ブログ
テレワークで始めたドキュメント駆動業務｜Dentsu Digital Tech Blog
プロダクト開発でドキュメントを書かないとどうなるか
開発ドキュメントの書き方！9つのコツ【エンジニア】
欅坂46ドキュメント映画が人死なないだけのサイコスリラーで泣きながら吐いた - kansou
Reactの環境構築 — 仕事ですぐに使えるTypeScript ドキュメント
IT業界に居ると海外製品の日本語ドキュメントが無くなったり機械翻訳になったりしていて我が国の経済的な没落を実感する