技術文書の書き方
howto-tech-docs.md 技術文書の書き方 このメモは、私（@ymmt2005）が長年にわたってソフトウェアプロダクト開発に関わってきて 2022年現在こうしたほうが良いと考えているベストプラクティスです。 科学的な分析等に基づくわけではない経験則であるため、今後も随時見直すことがありますし、 ここに書いてあることが常に正しいわけでもあらゆるソフトウェア開発に適するわけでもありません。 しかしながら、実務経験が豊富で、モダンな技術スタックに明るいエンジニアの経験則は一定の 役に立つのではないかと考えて記します。 技術文書とは ここでは、ソフトウェア開発で技術者が書くべき文書ということにします。 ソフトウェアエンジニアにも役割がいろいろあり、アーキテクトと independent contributor では書く文書が違うということはあるでしょうけれど、ここではごっちゃにします。
障害報告書を書こう！ - Qiita
担当しているITサービスなどに何かしらのインシデントや障害が発生した時に、対処後のアクションとして報告書を提出して事象の内容を報告（レポート）する場合がある。 提出先は会社の偉い人だったりクライアントだったり。場合によってはユーザー向けに発表したり。事の顛末を報告して「今後同様のことを起こさないように努力します、ごめんなさい」をするのだ。どのように再発防止の努力するのかを書くものでもある。 主にクライアント向けのビジネス内容ではあるが、自分が使っているテンプレパターンを共有するので参考にしてもらえればと思う。1 全般的なポイント 心得のようなもの。次の点は留意してて欲しい。 淡々と冷静な説明をこころがける 当然のことながら事実は脚色しない。無駄な修飾も要らない。客観的な事実を簡潔に述べる。 例： ❌「一生懸命頑張って対応したが…」 ❌「寝ないで対応したが…」 ❌「本当の原因は…」 できるだ
HowToWriteAnEffectiveDesignDocument - 設計文書のうまい書き方
HowToWriteAnEffectiveDesignDocument - 設計文書のうまい書き方 目次 この文書について 設計文書のうまい書き方 なぜ設計文書を書くのか 良い設計とは何か 同僚の開発者に向けて書く 第 1 節に書くこと: プロジェクト/サブシステムの目的を示す 第 2 節に書くこと: 設計に使う高レベルなエンティティを定義する 第 3 節に書くこと: 個々のエンティティに関する低レベルの設計を書く 使い方 設定 モデル 相互作用 第 4 節に書くこと: 利点, 前提, リスク/懸念事項 マネージャ向けに書くこと 最後に 設計文書のうまい書き方 この文書について "How to Write an Effective Design Document" の日本語訳です. http://blog.slickedit.com/?p=43 推敲歓迎: 誤訳, タイポ, 訳語の不統一,
ウノウラボ Unoh Labs: ベンチャー流Webサービスの作り方(開発チーム編)
尾藤正人(a.k.a BTO)です 前回はWebサービスを作るときの企画の部分について書きました (ベンチャー流Webサービスの作り方(企画編))。 今回はWebサービスを作るときの組織作りについて書いてみたいと思います。 僕がウノウに入って始めたのがフォト蔵の開発でした。 当初は開発が僕、ディレクションが代表の山田という二人体制でやってましたが、 組織が大きくなるにつれてだんだんと人数が増えていきました。 現在は僕も山田もフォト蔵からは離れて新しいチームで開発を行っています。 二人体制から始めて、少しずつ人数を増やしていって、 立ち上げメンバーが開発から離れるまでいろいろ経験しながら 自分が感じた事を簡単にまとめたいと思います。 ・最終決断は一人で 何をするのか、戦略はどうするのか、方向性は何なのか、最終的な決断はリーダーが一人で行います。 個人の主張を尊重しすぎて、各々が好きな事を始め
#5 （株）ライブドア 池邉智洋／谷口公一／ma.la（前編） 「そろそろライブドア事件について一言いっておくか」の「（中略）」にあったこと｜gihyo.jp
小飼弾のアルファギークに逢いたい♥ #5（株）ライブドア 池邉智洋／谷口公一／ma.la（前編） 「そろそろライブドア事件について一言いっておくか」の「（中略）」にあったこと 今回、弾さんが逢いに行ったのは、（株）ライブドアでRSSリーダー「livedoor Reader」、ソーシャルネットワーキングサービス（SNS）「livedoor フレパ」をはじめさまざまなコンテンツを持つlivedoorのポータルを開発している、池邉智洋さん、谷口公一さん、ma.laさん。弾さんがライブドアの前身、オン・ザ・エッヂ時代にCTOを務めた古巣は、すでに面影もなく新しい時代を築いているのかそれとも…。 編集部注） 本対談は2007年1月に行われたものです。 撮影：武田康宏 開発体制 弾：まずは自己紹介から。 池邉（以下、池）：ポータルを展開しているメディア事業部に、エンジニア
ソフトウェア開発者のための推薦図書
Code Complete 2 [ Code Complete第2版―完全なプログラミングを目指して (上・下) ] スティーブ・マコネルのCode Completeはソフトウェア開発者のための｢楽しい料理｣本だ。この本を読むということは、自分の仕事を楽しんでいるということであり、自分のすることに真剣であるということであり、もっと向上したいと思っているということなのだ。Code Completeの中で、スティーブは平均的なプログラマが読む 技術書は年に1冊に満たないと指摘している。この本を読んでいるという時点で、あなたはおそらく周りにいる開発者たちの90%と違う行動を取っていることになる。それもいい方向にだ。 私はこの本がすごく好きで、ここから自分のWebサイトの名前(Coding Horror)を取ったくらいだ。この本ではやるべきでない悪い例には"coding horror"アイコンで印
ITmedia Biz.ID：ITの「発明おじさん」――産業技術総合研究所・増井俊之さん
増井俊之さんは、ソニーコンピュータサイエンス研究所に在籍していたころに、現在も多くの携帯電話に搭載されている文章入力システム「POBox」を開発。これによって2005年に「第4回ドコモ・モバイル・サイエンス賞」を受賞した。その後もユーザーインタフェースの分野で研究やソフトウェア開発を続けている。情報整理にも独自の考え方を持ち「適当な道具がなければ自作する」という考え方だ。 増井さんの全情報を握るサーバと、そこにあるWiki 増井さんは、どこにいても小型軽量のLet's note R3でメモを取る。テキストエディタは自分で機能を追加したEmacsを使う。ネットが使える環境になったら、メモは増井さんがすべての情報を置いているサーバ内の自作Wikiにアップロードする。このWikiは、メモ・日記・ToDoリスト・スケジュール管理のために使っており、テキスト形式で入力するが、出力の形式はさまざまだ。
1
リリース、障害情報などのサービスのお知らせ
最新の人気エントリーの配信
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く
優秀な技術管理者:Geekなぺーじ