タグ

documentに関するnaglfarのブックマーク (52)

  • ソフトウェアドキュメント作法 - maru source

    こんにちは丸山@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日 これらのドキュメントは個人的にわりと良く書けたと思ってますし、

    ソフトウェアドキュメント作法 - maru source
  • いまこそ「良い仕様書」がチームの生産性の鍵となる。ので、仕様書に含めたい 14 のポイントについてまとめました。|Fritz | Lead Product Manager @ Mercari

    いまこそ「良い仕様書」がチームの生産性の鍵となる。ので、仕様書に含めたい 14 のポイントについてまとめました。 こんにちは、フリッツ です。今回はプロダクトマネージャーの日課とも言える「仕様書」について。自分にとっては PM 業の施策実行フェーズにおいて最も重要な仕事のひとつであり、最も心躍り、最も興奮する瞬間です。 PM になってかなりの時間が経ちましたが、「仕様書」への力の入れようは減るどころか、「もっと気合を入れなければ。」と感じる一方。在宅勤務が(たぶん) IT 業界のニュースタンダードとなっていくいま、なおさら「仕様書」の重要性を訴えたい今日この頃です。 ということで、今回は ・ 良い仕様書がもたらす 5 つの効果 ・ 仕様書の重要性が増していく 2 つの理由 ・ 仕様書に含めたい 14 の項目・実戦編 ・ 仕様書作成時に心に留めたい 3 つのこと ・ 具体的な仕様書サンプル(

    いまこそ「良い仕様書」がチームの生産性の鍵となる。ので、仕様書に含めたい 14 のポイントについてまとめました。|Fritz | Lead Product Manager @ Mercari
    naglfar
    naglfar 2021/01/22
    長いんだけど「ほんとそれ」が詰まってた。コミュニケーションコスト、削減したい。
  • 設計書には何を書くべきなのか - terurouメモ

    設計とは、 要求(やりたいこと)をヒアリングする 要求を要件(何を満たさないといけないのか)に落とし込む 要件を実現するために考えられる手段を洗い出す 手段の検証を行う 検証結果を元に、どの手段を使うかを選定する 選定した手段を合意する(一部要件を満たさない事項がある場合は、代替策や妥協ラインについても合意する) 合意内容を元に、実装や設定に落とし込む をやることである。画面設計や機能設計のように、3-5の検証/選定が薄くなったり曖昧になったりするものはあるが、一般化するとこの流れになる。 設計書には、上記の設計でやってきたことを順番に書いていけばよい。これを文章構成のテンプレに落としていくと、 要求 要件 方式 対応案(いわゆる比較表で書いていくのが楽) 検証結果 選定・合意結果(合意した代替策や妥協ラインについても記載する) 詳細設計(どういう実装にするとか、パラメーターにするとか、細

    設計書には何を書くべきなのか - terurouメモ
    naglfar
    naglfar 2020/08/03
    今までに「なぜ」を書いてるドキュメント、ほとんど見た覚えない。意識的に残していきたい。
  • 【社内資料公開】運用手順書を作る時のポイントについて書いてみた | DevelopersIO

    はじめに こんにちは植木和樹@上越妙高オフィスです。日は私がここ10年くらい意識している運用手順書を書くときのポイントについてまとめてみました。 対象読者 開発・構築したシステムを別の人に引き継ぐ予定のある人 他の人が作ったシステムを引き継ぐ担当の人 半年後の自分でも分かる手順書の書き方に困っている人 (この記事を読むのにかかる時間の目安:5分) 1. ドキュメントの冒頭に書くこと まず個々の詳細手順の前に、ドキュメント自体について記載してもらいたいことです。 1.1. ドキュメントに書かれていることを3行で書く ドキュメントの最初には、このドキュメントに何が書かれているのかを100文字くらいで書いておくと良いでしょう。 システムが増えれば増えるほど手順書も増えていくものです。見つけたドキュメントに自分の期待するものが書かれているのか、冒頭数行でわかるようになっているとうれしいです。 1

    【社内資料公開】運用手順書を作る時のポイントについて書いてみた | DevelopersIO
  • plan BUTAKIKAKU!! ORCSOFTの企画書を見てみようのコーナー!!

    Q「企画書ってどう作るの?」 A「良く聞かれますが、僕が聞きたいくらいです!」 というやり取りを重ねること数知れず! それでも抜きゲの企画を作ってみたい、送ってみたいという声を良く頂きますので、オークソフトではこういう風に企画を作っていますよというサンプルを提出させて頂きました。(ただしオークソフトでは今のところ飛び込みの企画書は募集しておりませんのでご注意)オープンオフィスというソフトを使って作ったものをPDFとして出力しておりますので若干崩れてしまっている箇所などもありますが、イメージは掴んで頂けるのではないでしょうか? クリックでBUTAKIKAKUをダウンロード!! 2013年9月時点で最新作の兄嫁ヒイヒイの企画書はさすがに公開出来ないので、準新作のかがち様を公開させて頂きました。 かなり荒い作りになっておりますので世の中にはもっと綺麗な企画書が沢山あると思います。 それを踏まえて

    plan BUTAKIKAKU!! ORCSOFTの企画書を見てみようのコーナー!!
    naglfar
    naglfar 2016/05/18
    ゲームの仕様書例。参考に。
  • Is Parallel Programming Hard, And, If So, What Can You Do About It?

  • Pandoc - index

    If you need to convert files from one markup format into another, pandoc is your swiss-army knife. Pandoc can convert between the following formats: (← = conversion from; → = conversion to; ↔︎ = conversion from and to) Lightweight markup formats ↔︎ Markdown (including CommonMark and GitHub-flavored Markdown) ↔︎ reStructuredText → AsciiDoc ↔︎ Emacs Org-Mode ↔︎ Emacs Muse ↔︎ Textile → Markua ← txt2t

    naglfar
    naglfar 2012/11/12
    EPUB もある。
  • 開発者向けのソフトウェア設計書は必要か? - 勘と経験と読経

    時々組織の内外で盛り上がるネタの一つに「設計書は必要なのか」談義がある。今回も後輩の一人から設計書不要論がぶつけられてきたので、現時点での個人的見解をまとめておくもの。個人的には、ソフトウェアの設計書は必須でもないし、開発戦略を練る段階で作成するかどうかを決めればいいと思っている。 議論の前提:仕様書と設計書 議論を簡単にするために、まず「仕様書」と「設計書」という言葉を再定義しておきたい。今回の整理は以下としている。 仕様書 … 開発者とユーザー(仕様決定者)が、ソフトウェアの振る舞いや動きに関してコミュニケーションするために必要な文書類のこと。 設計書 … 開発者どうしがソフトウェアを作成するにあたっての、構造や仕様についてコミュニケーションするために必要な文書類のこと。 要は今回議論しようとしている「設計書」は、ユーザー(仕様決定者)とは無関係なものであるという前提である。また、ここ

    開発者向けのソフトウェア設計書は必要か? - 勘と経験と読経
  • HowToWriteAnEffectiveDesignDocument - 設計文書のうまい書き方

    HowToWriteAnEffectiveDesignDocument - 設計文書のうまい書き方 目次 この文書について 設計文書のうまい書き方 なぜ設計文書を書くのか 良い設計とは何か 同僚の開発者に向けて書く 第 1 節に書くこと: プロジェクト/サブシステムの目的を示す 第 2 節に書くこと: 設計に使う高レベルなエンティティを定義する 第 3 節に書くこと: 個々のエンティティに関する低レベルの設計を書く 使い方 設定 モデル 相互作用 第 4 節に書くこと: 利点, 前提, リスク/懸念事項 マネージャ向けに書くこと 最後に 設計文書のうまい書き方 この文書について "How to Write an Effective Design Document" の日語訳です. http://blog.slickedit.com/?p=43 推敲歓迎: 誤訳, タイポ, 訳語の不統一,

  • 「ある人物に対する評価がものの判断を誤らせる危険性」について

    小田嶋隆 @tako_ashi 【ご報告】てなことで「オレは非科学的なデータにまどわされて不安に陥るようなチキンじゃないぞ」族 のより端的な名称は @bubblesgoto  さんのご提案により「マッチョサイエンティスト」およびそのまた略称の「マサイ族(笑)」(←(笑)まで含みます)に決定いたしました。 2012-02-11 15:50:09 岩田健太郎 K Iwata, MD, MSc, PhD, FACP, FIDSA, CIC, CTH @georgebest1969 小田嶋氏の上杉隆氏記事に対するコメント興味深いです。@levinassien: @tako_ashi 小田嶋さんが福島について、とてもクールな文章を書いてくれました。みんな読んでね。ア・ピース・オブ・警句「レッテルとしてのフクシマ」http://t.co/UGIkyxGF 2012-03-23 09:51:02

    「ある人物に対する評価がものの判断を誤らせる危険性」について
  • とり・みき先生から始まる「マンガの感嘆符・疑問符」

    とり・みき/TORI MIKI @videobird よくいわれるけど僕のネームの「!?」の使い方はそんなに特殊でしょうか。RT @hachimoto8 驚くセリフに連続で「!?」をつけるととり・みきっぽくなる気がする 例:「ブルータス!? お前もか!?」 2012-02-17 23:26:09 蜂 @hachimoto8 @videobird 読んでいる時に気になったりはしないのですが、間と調子がすりこまれているのか、別の場所で二連「!?」に遭遇すると「あっ、とり・みきだ!」という具合に再生されます。 2012-02-17 23:31:38 さあにん@山直人 @sarnin 単独の!?という吹き出しは、他の作家さんより多いと思います、。RT @videobird: よくいわれるけど僕のネームの「!?」の使い方はそんなに特殊でしょうか。RT @hachimoto8 驚くセリフに連続で「

    とり・みき先生から始まる「マンガの感嘆符・疑問符」
  • Wizardry Online 【種族について】

    岩原ケイシ/紅蓮士 @arahawi ■ムーク火の元素(炎) ~ファー(FUR)から生まれた種族。ドワーフと相性がいい。この世界の知的種族の中で最も謎に包まれた種族がムークである。彼らはどこの大陸から流れてきたのかまったくそのルーツが分からないのである。 #Wizardry_Online 2012-01-24 13:08:20 岩原ケイシ/紅蓮士 @arahawi (ムーク続き)賢者は、彼らを星界からの訪問者の末裔であると語っている。つまり宇宙人の末裔だ。外見は全身を長く柔らかな毛に包まれており、身長は2mを超える。彼らは人里離れたところに、家族単位でひっそりと暮らしている。 #Wizardry_Online 2012-01-24 13:09:02

    Wizardry Online 【種族について】
  • Wizardry Online 【神龍の相続者たち】 - Togetter

    岩原ケイシ/紅蓮士 @arahawi 天龍メリィ・ウェザー(Merry weather)超高度を飛行する体長数百メートルの龍。アザルス大陸北山脈に巣があるが、一度飛び立ったら何年も降りてこない。その姿を見た者に幸運をもたらすと言われている。風を司る。 #Wizardry_Online 2012-01-19 13:58:23 岩原ケイシ/紅蓮士 @arahawi 海龍ナイトカイト(Nightkite)メリィ・ウェザーの双子の姉。その巨体は海上の島のようであり、その腹の中にはこの世の秩序を乱しかねない強大な悪魔が封印され眠っているという噂もある。水を司る。 #Wizardry_Online 2012-01-19 13:59:22 岩原ケイシ/紅蓮士 @arahawi 地龍バロウバロウ(Barowbarow)アザルス大陸で大地の力を象徴する龍。形状はワーム。長さは何百キロもある。その存在は認めら

    Wizardry Online 【神龍の相続者たち】 - Togetter
  • http://nekobako.sh4.jp/kikaku/goroku.html

  • 極めて実用的な画像ばかりが貼られるスレ - ねとねた

  • 変態って奥深すぎだろwwwwwwwwww ニコニコVIP2ch

    ニコニコVIPユーザー様、お世話様です!(´・ω・`) 春の装い・・ちょっとダッシュすると汗ばむ位ですね。 外出するとき、コート着て出たら「熱っ!」ってなって 次の日はシャツ一枚で出たら、「寒っ!」みたいなこと けっこうありますよね・・汗 こんなときは「ジャケット」とか「薄いカーディガン」とか 一枚あると、とっても助かっちゃいますよ♪ せっかく買うなら、長く着れるモノがいいですよね! そんな一枚、探してみませんか? by店長:宇賀神 ⇒avexの某アーティストが1日店長に!? 1 以下、名無しにかわりましてVIPがお送りします 投稿日:2010/03/25(木) 10:34:48.83 ID:cxYxwKrp0 立つかな? 2 以下、名無しにかわりましてVIPがお送りします 投稿日:2010/03/25(木) 10:36:51.45 ID:cxYxwKrp0 おお立った

  • やけに分かる図解「手榴弾の仕組み」

    お~素晴らし~。 8世紀東ローマ、元寇でも使われたハンドヘルド爆弾、手榴弾。 その仕組みを1枚にまとめたインフォグラフです。 解説だけじゃなく、小史もさりげなく交えてるし、あれこれ酷い目に遭ってるヒト見るだけで状況が分かるっていうか...教材の王道ですねー。世にマニュアルは数あれど、これは妙に分かり易くて感心しましたよ。 上から順番に訳しておきます。 手榴弾は戦争で昔から使われてきた。どの手榴弾も爆弾としては最もベーシックながら短射程でもっと具体的ダメージを与えるほか、兵士がひとりで何個も持ち運べる設計になっている。以下の簡単ガイドで装置の仕組みを理解してみよう。 ヨーロッパの初期の手榴弾:15~16世紀 1. スパークや火の源が要る 2. 芯に火をつけ、手榴弾を投げる(投擲) 3. 中に詰めた火薬が爆発する 4. 金属の弾筒が炸裂し、榴散弾としての役目を果たす → 初期の手榴弾はヒューズ

    やけに分かる図解「手榴弾の仕組み」
  • https://katsu.watanabe.name/ancientfj/article.php?mid=%3C510ts4%24bur%40icews5.ipc.kanazawa-u.ac.jp%3E

    naglfar
    naglfar 2010/03/19
    自分の文化はコレだった。忘れたくないのでぶくま。エントリ起こそうかなあ。
  • プロレス技のブレーンバスターの派生技を出来るだけ教えて下さい。例、ブレーンバスタースラム - まずは原型となった『ブレーンバスター... - Yahoo!知恵袋

    まずは原型となった『ブレーンバスター』。 キラー・カール・コックスが開発し、ディック・マードックが受け継ぎました。 現在使われている垂直落下式との違いは叩き付け方。原型式は相手の体を垂直に持ち上げたまま、一度尻もちをつくように倒れこみ、角度を保ったまま的確に脳天から落とします。 ここから派生したのが背中から叩きつける、一般的に使われるブレーンバスター。 ハーリー・レイスは『バーティカルスープレックス』と呼ばせていました。 高速で投げるブレーンバスター。ダイナマイト・キッドなどが代表例。『剃刀ブレーンバスター』、『高速ブレーンバスター』、『スナップスープレックス』などと呼ばれています 長時間、相手を持ち上げ続けてから叩きつける『長滞空ブレーンバスター』。リック・フレアーや小橋建太などが使い手。中には1分近く持ち上げ続ける選手もいます。 コーナーから雪崩式で投げるブレーンバスター。阿修羅原が公

    プロレス技のブレーンバスターの派生技を出来るだけ教えて下さい。例、ブレーンバスタースラム - まずは原型となった『ブレーンバスター... - Yahoo!知恵袋
    naglfar
    naglfar 2010/03/18
    カテゴリマスターは伊達じゃないのか。
  • 垂水源之介の医療人類学辞典

    【あ】a あーゆるゔぇーだー アーユルベーダー(アーユルヴェーダー) あいこくしゅぎ 愛国主義 あいでんてぃてぃ アイデンティティ あいひまんもんだい アイヒマン問題 あくぎょう 悪行 あくしょんじんるいがく アクション人類学 あくしょんりさーち アクション・リサーチ (→アク ション人類学) あくらしあ アクラシア(→Ike-Cyclopedia 「アクラシア」) あどぼかしー アドボカシー あついきじゅつ 厚い記述 あぱるとへいと アパルトヘイト あやわすけろ アヤワスケロ(ayahuasquero) あとみっくそるじゃー アトミックソルジャー あふぉーだんす アフォーダンス あにみずむ アニミズム あるちゅう アル中(アルコール中毒症/依存症)(→サブスタンス依存) あるこーる・あのにます アルコール・アノニマス あるこーる アルコール あれん アレン、ウィリアム あろめとりー アロ