プロダクトマネージャーの必須スキル: デザインドックの書き方 - Design Doc｜kosuke mori
私 (@kossmori) が働くアメリカのスタートアップでは、どんな会話においても ”Is there a design doc?” (デザインドックはないの?) という質問が連発します。 会話のコンテクストを合わせるため、取り組みの背景を理解するための必須資料として位置づけられています。 デザインドックは技術詳細を書いた仕様書ではありません。 取組みに関わる Why, What, How と、ハイレベルな実装戦略、主要な設計上の決定、決定の際に考慮されたトレードオフに重点を置いて文書化したもので、それをもとにエンジニアは必要に応じてTech docを書き、デザイナーはデザインを始めます。 追記: その2も書きました。最後の方に記事へのリンクを貼っています。 追追記: 思った以上に反響あり、この記事のおかげでこれまで非常に多くの スタートアップの方々とお話しさせていただく機会をいただき
Googleなどで利用されているDesign Doc入門 - MyEnigma
How Google Works (日本経済新聞出版) 目次 目次 はじめに Design Docの要点メモ 参考資料 MyEnigma Supporters はじめに GoogleなどのIT企業がソフトウェアを開発する際には Design Docというドキュメントを利用しているそうです。 Design Docは「設計書」と訳されることが多いですが、 日本語の設計書とは少し意味合いが違うようです。 今回は、このDesing Docの要点を、 末尾の参考資料を元に勉強してみたので、 自分用のメモとしてまとめておきたいと思います。 Design Docの要点メモ Design Docは、 これから新しく開発しようとするソフトウェアの全体の設計や、 既存のコードのpatchやプルリクエスト(PR)のコード変更の 基本的な要点をまとめる文書です。 PRを作成する前に、Design Docを作成して
デザインドックで学ぶデザインドック | フライウィール
エンジニアの太田です。 皆さん、デザインドックはご存知でしょうか？いわゆる設計書ですが、エンジニアによって書かれ、書いた本人またはチームによって実装される点と、技術的な詳細を明確にし技術的な議論をすることにフォーカスがある点が特徴です。他人に開発を依頼するための設計書や、既存のシステムを解説するための文章とは性質が異なります。 デザインドックを書くことの利点としては以下のような点があります。 開発を始める前に全体のシステムを考察する機会を得る文章化することで、曖昧な部分が明確になる早い段階でチームメイトや専門家、関係者からフィードバックを得る機会を得るシステムの設計について明確な承認を得られる新しいメンバーがシステムの概略を理解する手助けになる弊社でもすでに多くのデザインドックを利用しており、エンジニア間での議論の活発化を担っています。 具体的にどのような内容を書けばいいのでしょうか？今回
【メモ】良いDesign Docs(Software Design Document)を書くためのリソース集
自分が良い Design Docs(Software Design Document)を書くために、読んだ/参考になったリソース集 一覧 Design Docs とは Design Docs at Google デザインドック(Design Doc)について デザインドックで学ぶデザインドック 残業も減らせる!? 上級エンジニアになるための Design Doc 超入門 「Design Doc」って何なのか？ What Is A Design Doc In Software Engineering? (full example) What is a Design Doc: Software Engineering Best Practice #1 https://github.com/kaiinui/note/blob/master/Design--Designdoc.md Googleの
メルカリShopsでのDesign Docs運用について | メルカリエンジニアリング
こんにちは! ソウゾウのSoftware Engineerの@ogataka50です。連載：メルカリShops 開発の裏側 Vol.2の9日目を担当させていただきます。 9日目はメルカリShopsを開発する中でのDesign Docsの運用について紹介させて頂きます。 Design Docsとは Design DocsとはGoogleなどで取り入れられているシステム設計ドキュメント手法です。開発をする前にプロジェクトの背景や目的、設計、検討した代案などをdocument化します。そしてそれを持って関係者との共有、議論を行うことによって事前に全体を考察し、精度を高め開発後の手戻りを減らすなどが主な目的になります。 例として、GoogleでのDesign Docsについては下記にまとめられています。 Design Docs at Google メルカリShopsでのDesign Docsのte
GoogleのDesign Docsから学ぶソフトウェア設計 - Qiita
概要 Design Documentと聞くと何を想像しますか？ 一般的にDesign Documentが指すのは設計書であることが多いのではないでしょうか。 設計書、簡単に説明するのであればソフトウェアを「どうやって作るの？」を説明したドキュメントです。 Googleではソフトウェアエンジニアリング文化における重要な要素として、今回お話ししていくDesign Docsと呼ばれるものがあります。 Design Docsとは？ Design Docsとは、開発者がコーディングに着手する前にソフトウェアシステムまたはアプリケーションの開発する人が作成するドキュメントです。 => ソフトウェア設計における仕様書や設計書とは別物と捉えた方がよいです。 仕様書、設計書は作成した上でのDesign Docsの作成となるようです。 このドキュメントには、高レベルの実装戦略と主な設計の決定事項がまとめられて
ドキュメントは最強のコミュニケーションツールである――Joelの機能仕様書入門
ドキュメントは最強のコミュニケーションツールである――Joelの機能仕様書入門：プロジェクト成功確率向上の近道とは？（1）（1/2 ページ） ITシステム開発の問題点の一つであるコミュニケーションの失敗。本連載では、これを防ぐ方法としてお勧めしたい3つのドキュメントを紹介していく。今回は「Joelの機能仕様書」のポイントを解説する。 連載目次 はじめに 本連載では、ITシステム開発がビジネスに貢献していくために必要な、最も基本的な条件である“システム開発の成功”につながるいくつかのポイントを紹介します。 筆者は、さまざまなコンピューターシステム開発に長年携わってきたソフトウェア技術者ですが、この連載では、あえて技術的ではない話題を中心に述べます。というのも、技術論だけではシステム開発が成功する条件としては不十分ですし、すでにたくさんの優れた技術論が各方面で展開されています。あらためてそこ
残業も減らせる!? 上級エンジニアになるためのDesign Doc超入門
残業も減らせる!? 上級エンジニアになるためのDesign Doc超入門：プロジェクト成功確率向上の近道とは？（3）（1/3 ページ） ITシステム開発の問題点の一つであるコミュニケーションの失敗。本連載では、これを防ぐ方法としてお勧めしたい3つのドキュメントを紹介していく。今回は、「技術視点」のドキュメントとして、2000年代以降注目されている「Design Doc」について解説します。 IT技術がビジネスに貢献していくためには、まずはシステム開発を成功させることが重要です。本連載「プロジェクト成功確率向上の近道とは？」では、システム開発を成功させるために、コミュニケーションが果たす役割の重要性と、ドキュメントによるコミュニケーションの重要性について解説してきました。 連載1回の「ドキュメントは最強のコミュニケーションツールである――Joelの機能仕様書入門」、第2回の「サンプル例に見る
基本設計書のテンプレート｜Shinji Yamaguchi
※ 設計書に関する本文およびテンプレートは制限無く公開しておりますので、当該記事をご購入頂かなくても設計書テンプレートの利用は可能です。応援いただける方のみご購入頂けますと幸甚です。こんにちは。 フリーランスエンジニアの山口です。 私は元々SIer企業の会社員エンジニアでしたが、2019年3月よりフリーランスエンジニアとして活動を始めました。 フリーになってから参画先のプロジェクトで経験したのは、意外と設計書のテンプレートは整備されていないということです。 そもそも設計書が存在していないとか、メンテ不能なPDF版で存在するとか、設計書のフォーマットがばらばらでメモ書きのような雑なものだったりなど。 そのような現場に入った際に利用可能なテンプレートがあると便利だと思いませんか？ 書籍でも設計書の書き方や設計書として揃えるべきドキュメントの種類を学ぶことは可能です。むしろ、書籍のほうがまとまっ
ポストCookieソリューションが起こす"アドテクノロジーの産業革命"｜インティメート・マージャーのData Driven NOTE
Google Chromeの3rd party cookieの利用制限の延期が発表されましたが、新しくGoogleの公式ブログに暗号化シグナル・Seller Defined Audiences（SDA）への対応などが進められているという話が掲載されていました。 私たちインティメート・マージャーは、日本国内を中心としてポストCookieソリューションサービスをリリースしていますが、連携をさせていただく先はPubmaticやRubiconなどのSSPやthe Trade DeskやDisplay & Video 360などのDSPなどグローバルにサービスを提供しているアドテクノロジーの会社が中心となっています。 そこで見えてきたアドテクノロジーの業界が超えていかなくてはいけない技術的な課題についてご紹介させていただければと思います。 DSPには3rd party cookieに紐づくデータを利
エンジニアが書く文章の問題点とは？ 伝わる文章のポイントは相手と目的の理解
翔泳社より発売中の『エンジニアのための文章術 再入門講座 新版』では、意外と苦手なエンジニアが多いという文章表現について伝わりやすくするための要点を解説。今回は「エンジニアが書く文章の問題点とは？」や「文章の説得技術には何が必要か？」といった改善すべきポイントが指摘されている「第1章 エンジニアが書く文章の問題点と文章表現力」を抜粋して紹介します。 本記事は『エンジニアのための文章術 再入門講座 新版 状況別にすぐ効く！文書・文章作成の実践テクニック』の「第1章 エンジニアが書く文章の問題点と文章表現力」を抜粋したもの。掲載にあたり一部を編集しています。 1-1 ビジネス向け文章作成に必要な素養 昨今、人工知能（AI）やデータ分析、デジタルトランスフォーメーションでビジネスモデルを根本から変えるような事例が世界中で生まれています。ビジネス環境はこれまでにないスピードで変化し、ICT・デジタ
元キーエンスのトップ営業が、新規事業をバンバン売るためにやっていること｜鶴岡 友也／BLUEPRINT Holdings CTO
うちの会社に、元キーエンスのとても優秀なセールスパーソンがいます。前職では、営業所の過去最高売上を何度も叩き出していた人です。 （↑Forbesにも取り上げてもらいました） 彼を採用したのは「新規事業」のセールスをしてもらうため。 ぼくらは「スタートアップファクトリー」を運営しています。革新的なスタートアップを次々生み出すビジネスモデルで、この1年ほどでvertical SaaSを中心に、10以上の事業を立ち上げてきました。 新規事業のセールスは、一般的な営業と比べてもかなり難しいです。 まだ商品がこの世に存在していない段階で「完成したら導入するよ」という内諾を得ないといけない。 彼が入社する前は正直、なかなか思うように成果が出ていませんでした。 しかし彼が来てから、事業は驚くほど加速しました。入社するなりすごい勢いで、アポや購入の内諾をとりつけていったのです。 いったい彼は、他のセールス
日本のソフトウェア企業でよく見るエンジニア組織の構造と、近年推奨されるエンジニア組織の構造について
はじめに 恥ずかしながらスクラム開発の開発チームへの導入を何度も経験しているのだけれど、どうしてもチームの成熟レベルが高い位置までもっていくことができませんでした なぜうまくいかないのか？ これを深掘りする過程で教科書どおりに実行するには組織の構造がスクラムガイドで書いてある構造と根本的に異なっているのではないか？と考えるようになりました。 よくあるエンジニア組織の構造 大きめのWebソフトウェア企業の内製型エンジニア組織の構造はだいたいどこもこのような感じになっています この組織構造の問題点 スクラムを導入する場合、リーダー自身かあるいはメンバーの一人がスクラムマスターとなります リーダー自身がスクラムマスターになる場合でもアンチパターンと言われる開発者との兼任になります。 スクラムマスターの最も重要な職務である「観察」が行えなくなります。 スクラムマスター自身が観察を行わない場合、各メ
運用・監視っていう対象がよく分からないのでまとめてみた | DevelopersIO
はじめに おはようございます、もきゅりんです。 この界隈に生息していると耳にする「運用・監視」。(聞きませんか？) 概念は広いし、抽象的だし、明確な定義があるわけでもなさそうなので、自分は今ひとつ何をどこまで考えるものなのかよく分かっていませんでした。 でもよく分からないまま使うのは、気持ちが悪い。 ということで、とりあえず自分がまとめた一例をとりあえずブログにしておきます。 運用・監視とは まず「運用・監視」という用語ですが、運用という概念の中に監視が含まれているため、そもそも並列で使うものではなさそうです。 耳にしたこともあるし、自分も特に気にせず使っていましたが、「運用」で良さそうです。 「監視」については、後述します。 運用ですが、機能・役割によっていくつかに分別ができるようです。 自分が確認した限り *1、とりあえず下記3つの機能・役割で大きく分けられそうです。 なお、あえて自分
【社内資料公開】構築担当者向け 運用チームに引き継ぐ時に気にしてほしい3つのポイント | DevelopersIO
はじめに こんにちは植木和樹＠上越妙高オフィスです。AWS上でのインフラ構築が終わり、アプリケーションがデプロイされるといよいよサービスローンチ。数日〜数週間様子をみて問題がなければ運用チームに業務を引き継ぐことが多いかと思います。 運用チームへの引き継ぎ資料を作って「あとはよろしくね」となるわけですが、その段階で「待て」がかかってしまうことがあります。（だいたい待てを言うのは私なんですが） 今回はスムーズに運用チームに業務引き継ぎができるように、私が注意しているポイントをまとめておきたいと思います。 3つのポイント 注意するポイントは3つです。 1. Input なにをトリガーに作業が始まるのか。どんな通知がくるのか。 2. Action 何をするのか。 3. Output 作業が終わったら誰に報告するのか。 1つずつ説明していきます。 1. Input 運用チームは基本的に「イベント・
続・深刻なシステムの引き継ぎ問題
前回の記者の眼（1月13日）で「システムの引き継ぎ問題」について経験談を募ったところ，多数の投稿を寄せていただいた。ありがとうございます。今日はその結果をご報告させていただくと同時に，それらの具体的なケースに基づいて，現場で起きている2007年問題の本質がどこにあるのかを考えてみたい。 前回，「限られた取材では大きなトレンドを判断しにくい。改めてここでIT Pro読者の意見を求めたい」と投げかけた。問題提起の発端は“2007年問題”であった。まずは，寄せられた投稿を基に整理した私の考えを書きたい。 一般的に「2007年問題」と言うと，「優秀なベテラン技術者が持つスキルが次の世代に引き継がれないこと」と定義される。例えば，ファイバースコープのレンズ磨きのように，徒弟方式でしか伝えられないスーパーハイレベルなスキルが若い世代では断絶する可能性がある，という類のものである。 しかし，情報システム
システム引き継ぎ時のポイントは？ | 株式会社アクシア
最終更新日：2023年11月24日 システムの引き継ぎは、やるべきことが多くあります。また、引き継ぎの際に必要な情報がうまく伝達できていないと、引き継ぎ後の業務やシステム改修の進行がスムーズにいかないこともあります。 そこでこの記事では、システムの引き継ぎにフォーカスを当てて紹介します。社内の引き継ぎだけではなく、システム開発会社へ引き継ぎを行う際のポイントもまとめました。 この記事で得られる情報は以下の通りです。 システムの引き継ぎとは？ システム引き継ぎ時に必要な準備・情報 システム引き継ぎの流れ システム引き継ぎ時のポイント 引き継ぎを依頼するシステム開発会社（ベンダー）の選び方 システム開発会社に引き継ぎを依頼する際の注意点 この記事がお役に立ちましたら幸いです。 アクシアでは他社で構築したシステムの保守引き継ぎを行っています。システムの引き継ぎでお困りの際はお気軽にご相談ください
運用引き継ぎについて - Qiita
ログの設計についてどのように考えるべきなのかを知りたかったため読んだが、周辺知識も有用だったため運用引き継ぎのパートをまとめ 前提 運用設計の目的の一つが、複雑な作業を整理して誰にでも作業できるようすること 運用引き継ぎとは 運用担当者が必要なフローや手順を理解し、必要なドキュメントやデータにアクセスできるようにすること 運用引き継ぎの方法 運用引き継ぎの方法は大きく分けて2つ ドキュメントの引き継ぎ スキルトランスファー ドキュメントの引き継ぎ 運用を行う上での意思決定に必要な情報を意識した精査、作成 対顧客ドキュメント インフラ構成ドキュメント アプリケーション構成ドキュメント 運用設計ドキュメント 顧客ドキュメント 顧客に対するドキュメント 顧客に依頼されたドキュメントやガイドライン的なものなども。 個人的には顧客への対応ノウハウもあっても良いと思う インフラ構成ドキュメント アーキ
リリース、障害情報などのサービスのお知らせ
最新の人気エントリーの配信
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く
システム運用のオシゴトって、どんなことをしているの？『運用☆ちゃん』Incident 001 - リクナビNEXTジャーナル